Cisco-IOS-XR-ipv4-igmp-oper API API Reference
API generated from Cisco-IOS-XR-ipv4-igmp-oper@2018-01-31.yang
API Endpoint
http://{Controller-IP}:{Controller-Port}/restconf/operational/network-topology:network-topology/topology/topology-netconf/node/{{node-name}}/yang-ext:mount/URL '/' code: %2F
Schemes: http
Version: 1.0.0
Paths
MLD - Retrieve
Retrieve operation of resource: mld
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"active": {
"default-context": {
"interface-state-offs": {
"interface-state-off": [
{
"interface-name": "string",
"las-ll-remove-update-count": "integer",
"las-ll-add-update-count": "integer",
"las-update-count": "integer",
"configurationvrf-set": "boolean",
"vrf-id": "integer",
"subscriber-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"vrf-state": "integer",
"last-member-query-interval": "integer",
"interface-name-xr": "string",
"is-las-registered": "boolean",
"group-leaves": "integer",
"is-router-enabled": "boolean",
"las-get-address-count": "integer",
"subscriber-mode": "integer",
"total-active-groups": "integer",
"configuration-mcast-vrf-set": "boolean",
"querier-uptime": "integer",
"proxy-interface": "string",
"is-subscriber": "boolean",
"mte-vrf-id": "integer",
"state": "string",
"time-since-last-query-in-seconds": "integer",
"location": "integer",
"subscriber-id": "string",
"is-ip-enabled": "boolean",
"router-uptime-in-seconds": "integer",
"parent-ifhandle": "string",
"query-interval": "integer",
"configuration-mcast-vrf-error": "boolean",
"is-identity-present": "boolean",
"query-timeout": "integer",
"query-maximum-response-time": "integer",
"querier-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"igmp-version": "integer",
"las-ll-registration-count": "integer",
"is-interface-up": "boolean",
"mte-tuple-count": "integer",
"is-las-request": "boolean",
"prefix-length": "integer",
"las-null-update-count": "integer",
"is-querier": "boolean",
"robustness": "integer",
"las-unregistration-count": "integer",
"is-im-state-registered": "boolean",
"mtu": "integer",
"is-configurationverify": "boolean",
"time-since-last-report-in-seconds": "integer",
"configurationvrf-error": "boolean",
"host-version": "integer",
"group-joins": "integer"
}
]
}
}
}
}
STANDBY - Retrieve
Retrieve operation of resource: standby
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"default-context": {
"interface-state-offs": {
"interface-state-off": [
{
"interface-name": "string",
"las-ll-remove-update-count": "integer",
"las-ll-add-update-count": "integer",
"las-update-count": "integer",
"configurationvrf-set": "boolean",
"vrf-id": "integer",
"subscriber-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"vrf-state": "integer",
"last-member-query-interval": "integer",
"interface-name-xr": "string",
"is-las-registered": "boolean",
"group-leaves": "integer",
"is-router-enabled": "boolean",
"las-get-address-count": "integer",
"subscriber-mode": "integer",
"total-active-groups": "integer",
"configuration-mcast-vrf-set": "boolean",
"querier-uptime": "integer",
"proxy-interface": "string",
"is-subscriber": "boolean",
"mte-vrf-id": "integer",
"state": "string",
"time-since-last-query-in-seconds": "integer",
"location": "integer",
"subscriber-id": "string",
"is-ip-enabled": "boolean",
"router-uptime-in-seconds": "integer",
"parent-ifhandle": "string",
"query-interval": "integer",
"configuration-mcast-vrf-error": "boolean",
"is-identity-present": "boolean",
"query-timeout": "integer",
"query-maximum-response-time": "integer",
"querier-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"igmp-version": "integer",
"las-ll-registration-count": "integer",
"is-interface-up": "boolean",
"mte-tuple-count": "integer",
"is-las-request": "boolean",
"prefix-length": "integer",
"las-null-update-count": "integer",
"is-querier": "boolean",
"robustness": "integer",
"las-unregistration-count": "integer",
"is-im-state-registered": "boolean",
"mtu": "integer",
"is-configurationverify": "boolean",
"time-since-last-report-in-seconds": "integer",
"configurationvrf-error": "boolean",
"host-version": "integer",
"group-joins": "integer"
}
]
}
}
}
VRFS - Retrieve
Retrieve operation of resource: vrfs
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"vrf": [
{
"interface-state-offs": {
"interface-state-off": [
{
"interface-name": "string",
"las-ll-remove-update-count": "integer",
"las-ll-add-update-count": "integer",
"las-update-count": "integer",
"configurationvrf-set": "boolean",
"vrf-id": "integer",
"subscriber-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"vrf-state": "integer",
"last-member-query-interval": "integer",
"interface-name-xr": "string",
"is-las-registered": "boolean",
"group-leaves": "integer",
"is-router-enabled": "boolean",
"las-get-address-count": "integer",
"subscriber-mode": "integer",
"total-active-groups": "integer",
"configuration-mcast-vrf-set": "boolean",
"querier-uptime": "integer",
"proxy-interface": "string",
"is-subscriber": "boolean",
"mte-vrf-id": "integer",
"state": "string",
"time-since-last-query-in-seconds": "integer",
"location": "integer",
"subscriber-id": "string",
"is-ip-enabled": "boolean",
"router-uptime-in-seconds": "integer",
"parent-ifhandle": "string",
"query-interval": "integer",
"configuration-mcast-vrf-error": "boolean",
"is-identity-present": "boolean",
"query-timeout": "integer",
"query-maximum-response-time": "integer",
"querier-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"igmp-version": "integer",
"las-ll-registration-count": "integer",
"is-interface-up": "boolean",
"mte-tuple-count": "integer",
"is-las-request": "boolean",
"prefix-length": "integer",
"las-null-update-count": "integer",
"is-querier": "boolean",
"robustness": "integer",
"las-unregistration-count": "integer",
"is-im-state-registered": "boolean",
"mtu": "integer",
"is-configurationverify": "boolean",
"time-since-last-report-in-seconds": "integer",
"configurationvrf-error": "boolean",
"host-version": "integer",
"group-joins": "integer"
}
]
}
}
]
}
VRF - Retrieve
Retrieve operation of resource: vrf
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-state-offs": {
"interface-state-off": [
{
"interface-name": "string",
"las-ll-remove-update-count": "integer",
"las-ll-add-update-count": "integer",
"las-update-count": "integer",
"configurationvrf-set": "boolean",
"vrf-id": "integer",
"subscriber-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"vrf-state": "integer",
"last-member-query-interval": "integer",
"interface-name-xr": "string",
"is-las-registered": "boolean",
"group-leaves": "integer",
"is-router-enabled": "boolean",
"las-get-address-count": "integer",
"subscriber-mode": "integer",
"total-active-groups": "integer",
"configuration-mcast-vrf-set": "boolean",
"querier-uptime": "integer",
"proxy-interface": "string",
"is-subscriber": "boolean",
"mte-vrf-id": "integer",
"state": "string",
"time-since-last-query-in-seconds": "integer",
"location": "integer",
"subscriber-id": "string",
"is-ip-enabled": "boolean",
"router-uptime-in-seconds": "integer",
"parent-ifhandle": "string",
"query-interval": "integer",
"configuration-mcast-vrf-error": "boolean",
"is-identity-present": "boolean",
"query-timeout": "integer",
"query-maximum-response-time": "integer",
"querier-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"igmp-version": "integer",
"las-ll-registration-count": "integer",
"is-interface-up": "boolean",
"mte-tuple-count": "integer",
"is-las-request": "boolean",
"prefix-length": "integer",
"las-null-update-count": "integer",
"is-querier": "boolean",
"robustness": "integer",
"las-unregistration-count": "integer",
"is-im-state-registered": "boolean",
"mtu": "integer",
"is-configurationverify": "boolean",
"time-since-last-report-in-seconds": "integer",
"configurationvrf-error": "boolean",
"host-version": "integer",
"group-joins": "integer"
}
]
}
}
SUMMARY - Retrieve
Retrieve operation of resource: summary
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"group-count": "integer",
"disabled-interface-count": "integer",
"group-limit": "integer",
"supported-interfaces": "integer",
"robustness": "integer",
"is-disabled": "boolean",
"enabled-interface-count": "integer",
"node-low-memory": "boolean",
"unsupported-interfaces": "integer",
"tunnel-mte-config-count": "integer",
"interface": [
{
"group-count": "integer",
"parent-ifhandle": "string",
"router-uptime-in-seconds": "integer",
"interface-name": "string",
"group-limit": "integer",
"on-off": "boolean",
"time-since-last-report-in-seconds": "integer",
"time-since-last-query-in-seconds": "integer"
}
]
}
INTERFACE - Retrieve
Retrieve operation of resource: interface
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"group-count": "integer",
"parent-ifhandle": "string",
"router-uptime-in-seconds": "integer",
"interface-name": "string",
"group-limit": "integer",
"on-off": "boolean",
"time-since-last-report-in-seconds": "integer",
"time-since-last-query-in-seconds": "integer"
}
INTERFACE-STATE-ONS - Retrieve
Retrieve operation of resource: interface-state-ons
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-state-on": [
{
"las-ll-remove-update-count": "integer",
"las-ll-add-update-count": "integer",
"las-update-count": "integer",
"configurationvrf-set": "boolean",
"vrf-id": "integer",
"subscriber-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"vrf-state": "integer",
"last-member-query-interval": "integer",
"interface-name-xr": "string",
"is-las-registered": "boolean",
"group-leaves": "integer",
"is-router-enabled": "boolean",
"las-get-address-count": "integer",
"subscriber-mode": "integer",
"total-active-groups": "integer",
"configuration-mcast-vrf-set": "boolean",
"querier-uptime": "integer",
"proxy-interface": "string",
"is-subscriber": "boolean",
"mte-vrf-id": "integer",
"state": "string",
"time-since-last-query-in-seconds": "integer",
"location": "integer",
"subscriber-id": "string",
"is-ip-enabled": "boolean",
"router-uptime-in-seconds": "integer",
"parent-ifhandle": "string",
"query-interval": "integer",
"configuration-mcast-vrf-error": "boolean",
"is-identity-present": "boolean",
"query-timeout": "integer",
"query-maximum-response-time": "integer",
"querier-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"igmp-version": "integer",
"las-ll-registration-count": "integer",
"is-interface-up": "boolean",
"mte-tuple-count": "integer",
"is-las-request": "boolean",
"prefix-length": "integer",
"las-null-update-count": "integer",
"is-querier": "boolean",
"robustness": "integer",
"las-unregistration-count": "integer",
"is-im-state-registered": "boolean",
"mtu": "integer",
"is-configurationverify": "boolean",
"time-since-last-report-in-seconds": "integer",
"configurationvrf-error": "boolean",
"host-version": "integer",
"group-joins": "integer"
}
]
}
INTERFACE-STATE-ON - Retrieve
Retrieve operation of resource: interface-state-on
vrf-name
in path
string
ID of vrf-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"las-ll-remove-update-count": "integer",
"las-ll-add-update-count": "integer",
"las-update-count": "integer",
"configurationvrf-set": "boolean",
"vrf-id": "integer",
"subscriber-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"vrf-state": "integer",
"last-member-query-interval": "integer",
"interface-name-xr": "string",
"is-las-registered": "boolean",
"group-leaves": "integer",
"is-router-enabled": "boolean",
"las-get-address-count": "integer",
"subscriber-mode": "integer",
"total-active-groups": "integer",
"configuration-mcast-vrf-set": "boolean",
"querier-uptime": "integer",
"proxy-interface": "string",
"is-subscriber": "boolean",
"mte-vrf-id": "integer",
"state": "string",
"time-since-last-query-in-seconds": "integer",
"location": "integer",
"subscriber-id": "string",
"is-ip-enabled": "boolean",
"router-uptime-in-seconds": "integer",
"parent-ifhandle": "string",
"query-interval": "integer",
"configuration-mcast-vrf-error": "boolean",
"is-identity-present": "boolean",
"query-timeout": "integer",
"query-maximum-response-time": "integer",
"querier-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"igmp-version": "integer",
"las-ll-registration-count": "integer",
"is-interface-up": "boolean",
"mte-tuple-count": "integer",
"is-las-request": "boolean",
"prefix-length": "integer",
"las-null-update-count": "integer",
"is-querier": "boolean",
"robustness": "integer",
"las-unregistration-count": "integer",
"is-im-state-registered": "boolean",
"mtu": "integer",
"is-configurationverify": "boolean",
"time-since-last-report-in-seconds": "integer",
"configurationvrf-error": "boolean",
"host-version": "integer",
"group-joins": "integer"
}
ADDRESS - Retrieve
Retrieve operation of resource: address
vrf-name
in path
string
ID of vrf-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
QUERIER-ADDRESS - Retrieve
Retrieve operation of resource: querier-address
vrf-name
in path
string
ID of vrf-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SUBSCRIBER-ADDRESS - Retrieve
Retrieve operation of resource: subscriber-address
vrf-name
in path
string
ID of vrf-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
DETAIL-GROUPS - Retrieve
Retrieve operation of resource: detail-groups
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"detail-group": [
{
"source": [
{
"uptime": "integer",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"expiration-time": "string",
"is-local": "boolean",
"is-forward": "boolean",
"is-added": "boolean",
"flags": "string",
"is-remote": "boolean",
"is-we-report": "boolean"
}
],
"is-router-exclude-mode": "boolean",
"group-info": {
"uptime": "integer",
"older-host-version1-timer": "integer",
"row-status": "string",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-added": "boolean",
"older-host-version2-timer": "integer",
"last-reporter": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"expiration-time": "string",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-suppressed": "boolean",
"is-self-join": "boolean",
"is-low-memory": "boolean",
"interface-name-xr": "string",
"router-filter-mode": "integer",
"explicit-tracking-enabled": "boolean"
},
"is-host-exclude-mode": "boolean"
}
]
}
DETAIL-GROUP - Retrieve
Retrieve operation of resource: detail-group
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"source": [
{
"uptime": "integer",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"expiration-time": "string",
"is-local": "boolean",
"is-forward": "boolean",
"is-added": "boolean",
"flags": "string",
"is-remote": "boolean",
"is-we-report": "boolean"
}
],
"is-router-exclude-mode": "boolean",
"group-info": {
"uptime": "integer",
"older-host-version1-timer": "integer",
"row-status": "string",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-added": "boolean",
"older-host-version2-timer": "integer",
"last-reporter": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"expiration-time": "string",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-suppressed": "boolean",
"is-self-join": "boolean",
"is-low-memory": "boolean",
"interface-name-xr": "string",
"router-filter-mode": "integer",
"explicit-tracking-enabled": "boolean"
},
"is-host-exclude-mode": "boolean"
}
GROUP-INFO - Retrieve
Retrieve operation of resource: group-info
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"uptime": "integer",
"older-host-version1-timer": "integer",
"row-status": "string",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-added": "boolean",
"older-host-version2-timer": "integer",
"last-reporter": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"expiration-time": "string",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-suppressed": "boolean",
"is-self-join": "boolean",
"is-low-memory": "boolean",
"interface-name-xr": "string",
"router-filter-mode": "integer",
"explicit-tracking-enabled": "boolean"
}
GROUP-ADDRESS-XR - Retrieve
Retrieve operation of resource: group-address-xr
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
LAST-REPORTER - Retrieve
Retrieve operation of resource: last-reporter
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SOURCE-ADDRESS - Retrieve
Retrieve operation of resource: source-address
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SOURCE - Retrieve
Retrieve operation of resource: source
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"uptime": "integer",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"expiration-time": "string",
"is-local": "boolean",
"is-forward": "boolean",
"is-added": "boolean",
"flags": "string",
"is-remote": "boolean",
"is-we-report": "boolean"
}
SOURCE-ADDRESS - Retrieve
Retrieve operation of resource: source-address
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
NON-ACTIVE-GROUPS - Retrieve
Retrieve operation of resource: non-active-groups
vrf-name
in path
string
ID of vrf-name
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"non-active-groups": [
{
"interface": "string",
"group-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"reason-for-non-activity": "string",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
}
NON-ACTIVE-GROUPS - Retrieve
Retrieve operation of resource: non-active-groups
vrf-name
in path
string
ID of vrf-name
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface": "string",
"group-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"reason-for-non-activity": "string",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
GROUP-ADDRESS - Retrieve
Retrieve operation of resource: group-address
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SOURCE-ADDRESS - Retrieve
Retrieve operation of resource: source-address
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SSM-MAPS - Retrieve
Retrieve operation of resource: ssm-maps
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ssm-map": [
{
"source-counts": "integer",
"map-type": "integer",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
}
SSM-MAP - Retrieve
Retrieve operation of resource: ssm-map
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"source-counts": "integer",
"map-type": "integer",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
GROUP-ADDRESS-XR - Retrieve
Retrieve operation of resource: group-address-xr
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
EXPLICIT-GROUPS - Retrieve
Retrieve operation of resource: explicit-groups
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"explicit-group": [
{
"exclude-hosts": "integer",
"host": [
{
"uptime": "integer",
"source-address": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"is-exclude": "boolean",
"expiration-time": "integer",
"source-count": "integer",
"address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
],
"include-hosts": "integer",
"group-info": {
"uptime": "integer",
"older-host-version1-timer": "integer",
"row-status": "string",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-added": "boolean",
"older-host-version2-timer": "integer",
"last-reporter": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"expiration-time": "string",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-suppressed": "boolean",
"is-self-join": "boolean",
"is-low-memory": "boolean",
"interface-name-xr": "string",
"router-filter-mode": "integer",
"explicit-tracking-enabled": "boolean"
}
}
]
}
EXPLICIT-GROUP - Retrieve
Retrieve operation of resource: explicit-group
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"exclude-hosts": "integer",
"host": [
{
"uptime": "integer",
"source-address": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"is-exclude": "boolean",
"expiration-time": "integer",
"source-count": "integer",
"address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
],
"include-hosts": "integer",
"group-info": {
"uptime": "integer",
"older-host-version1-timer": "integer",
"row-status": "string",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-added": "boolean",
"older-host-version2-timer": "integer",
"last-reporter": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"expiration-time": "string",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-suppressed": "boolean",
"is-self-join": "boolean",
"is-low-memory": "boolean",
"interface-name-xr": "string",
"router-filter-mode": "integer",
"explicit-tracking-enabled": "boolean"
}
}
GROUP-INFO - Retrieve
Retrieve operation of resource: group-info
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"uptime": "integer",
"older-host-version1-timer": "integer",
"row-status": "string",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-added": "boolean",
"older-host-version2-timer": "integer",
"last-reporter": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"expiration-time": "string",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-suppressed": "boolean",
"is-self-join": "boolean",
"is-low-memory": "boolean",
"interface-name-xr": "string",
"router-filter-mode": "integer",
"explicit-tracking-enabled": "boolean"
}
GROUP-ADDRESS-XR - Retrieve
Retrieve operation of resource: group-address-xr
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
LAST-REPORTER - Retrieve
Retrieve operation of resource: last-reporter
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SOURCE-ADDRESS - Retrieve
Retrieve operation of resource: source-address
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
HOST - Retrieve
Retrieve operation of resource: host
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"uptime": "integer",
"source-address": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"is-exclude": "boolean",
"expiration-time": "integer",
"source-count": "integer",
"address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
ADDRESS - Retrieve
Retrieve operation of resource: address
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SOURCE-ADDRESS - Retrieve
Retrieve operation of resource: source-address
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
INTERFACE-TABLE - Retrieve
Retrieve operation of resource: interface-table
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface": [
{
"interface-name": "string",
"las-ll-remove-update-count": "integer",
"las-ll-add-update-count": "integer",
"las-update-count": "integer",
"configurationvrf-set": "boolean",
"vrf-id": "integer",
"subscriber-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"vrf-state": "integer",
"last-member-query-interval": "integer",
"interface-name-xr": "string",
"is-las-registered": "boolean",
"group-leaves": "integer",
"is-router-enabled": "boolean",
"las-get-address-count": "integer",
"subscriber-mode": "integer",
"total-active-groups": "integer",
"configuration-mcast-vrf-set": "boolean",
"querier-uptime": "integer",
"proxy-interface": "string",
"is-subscriber": "boolean",
"mte-vrf-id": "integer",
"state": "string",
"time-since-last-query-in-seconds": "integer",
"location": "integer",
"subscriber-id": "string",
"is-ip-enabled": "boolean",
"router-uptime-in-seconds": "integer",
"parent-ifhandle": "string",
"query-interval": "integer",
"configuration-mcast-vrf-error": "boolean",
"is-identity-present": "boolean",
"query-timeout": "integer",
"query-maximum-response-time": "integer",
"querier-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"igmp-version": "integer",
"las-ll-registration-count": "integer",
"is-interface-up": "boolean",
"mte-tuple-count": "integer",
"is-las-request": "boolean",
"prefix-length": "integer",
"las-null-update-count": "integer",
"is-querier": "boolean",
"robustness": "integer",
"las-unregistration-count": "integer",
"is-im-state-registered": "boolean",
"mtu": "integer",
"is-configurationverify": "boolean",
"time-since-last-report-in-seconds": "integer",
"configurationvrf-error": "boolean",
"host-version": "integer",
"group-joins": "integer"
}
]
}
INTERFACE - Retrieve
Retrieve operation of resource: interface
vrf-name
in path
string
ID of vrf-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"las-ll-remove-update-count": "integer",
"las-ll-add-update-count": "integer",
"las-update-count": "integer",
"configurationvrf-set": "boolean",
"vrf-id": "integer",
"subscriber-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"vrf-state": "integer",
"last-member-query-interval": "integer",
"interface-name-xr": "string",
"is-las-registered": "boolean",
"group-leaves": "integer",
"is-router-enabled": "boolean",
"las-get-address-count": "integer",
"subscriber-mode": "integer",
"total-active-groups": "integer",
"configuration-mcast-vrf-set": "boolean",
"querier-uptime": "integer",
"proxy-interface": "string",
"is-subscriber": "boolean",
"mte-vrf-id": "integer",
"state": "string",
"time-since-last-query-in-seconds": "integer",
"location": "integer",
"subscriber-id": "string",
"is-ip-enabled": "boolean",
"router-uptime-in-seconds": "integer",
"parent-ifhandle": "string",
"query-interval": "integer",
"configuration-mcast-vrf-error": "boolean",
"is-identity-present": "boolean",
"query-timeout": "integer",
"query-maximum-response-time": "integer",
"querier-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"igmp-version": "integer",
"las-ll-registration-count": "integer",
"is-interface-up": "boolean",
"mte-tuple-count": "integer",
"is-las-request": "boolean",
"prefix-length": "integer",
"las-null-update-count": "integer",
"is-querier": "boolean",
"robustness": "integer",
"las-unregistration-count": "integer",
"is-im-state-registered": "boolean",
"mtu": "integer",
"is-configurationverify": "boolean",
"time-since-last-report-in-seconds": "integer",
"configurationvrf-error": "boolean",
"host-version": "integer",
"group-joins": "integer"
}
ADDRESS - Retrieve
Retrieve operation of resource: address
vrf-name
in path
string
ID of vrf-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
QUERIER-ADDRESS - Retrieve
Retrieve operation of resource: querier-address
vrf-name
in path
string
ID of vrf-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SUBSCRIBER-ADDRESS - Retrieve
Retrieve operation of resource: subscriber-address
vrf-name
in path
string
ID of vrf-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
INTERFACE-UNICAST-QOS-ADJUSTS - Retrieve
Retrieve operation of resource: interface-unicast-qos-adjusts
vrf-name
in path
string
ID of vrf-name
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-unicast-qos-adjust": [
{
"is-virtual-access": "boolean",
"rate": "integer",
"rate-increments": "integer",
"rate-decrements": "integer",
"update": [
{
"is-add": "boolean",
"group-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"received-time": "integer",
"weight": "integer",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
}
]
}
INTERFACE-UNICAST-QOS-ADJUST - Retrieve
Retrieve operation of resource: interface-unicast-qos-adjust
vrf-name
in path
string
ID of vrf-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-virtual-access": "boolean",
"rate": "integer",
"rate-increments": "integer",
"rate-decrements": "integer",
"update": [
{
"is-add": "boolean",
"group-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"received-time": "integer",
"weight": "integer",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
}
UPDATE - Retrieve
Retrieve operation of resource: update
vrf-name
in path
string
ID of vrf-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-add": "boolean",
"group-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"received-time": "integer",
"weight": "integer",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
SOURCE-ADDRESS - Retrieve
Retrieve operation of resource: source-address
vrf-name
in path
string
ID of vrf-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
GROUP-ADDRESS - Retrieve
Retrieve operation of resource: group-address
vrf-name
in path
string
ID of vrf-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
RANGES - Retrieve
Retrieve operation of resource: ranges
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"range": [
{
"is-stale": "boolean",
"protocol": "string",
"prefix-length": "integer",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
}
RANGE - Retrieve
Retrieve operation of resource: range
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-stale": "boolean",
"protocol": "string",
"prefix-length": "integer",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
GROUP-ADDRESS-XR - Retrieve
Retrieve operation of resource: group-address-xr
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
IFRS-INTERFACES - Retrieve
Retrieve operation of resource: ifrs-interfaces
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ifrs-interface": [
{
"join-group-count": "integer",
"igmp-interface-entry": {
"las-ll-remove-update-count": "integer",
"las-ll-add-update-count": "integer",
"las-update-count": "integer",
"configurationvrf-set": "boolean",
"vrf-id": "integer",
"subscriber-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"vrf-state": "integer",
"last-member-query-interval": "integer",
"interface-name-xr": "string",
"is-las-registered": "boolean",
"group-leaves": "integer",
"is-router-enabled": "boolean",
"las-get-address-count": "integer",
"subscriber-mode": "integer",
"total-active-groups": "integer",
"configuration-mcast-vrf-set": "boolean",
"querier-uptime": "integer",
"proxy-interface": "string",
"is-subscriber": "boolean",
"mte-vrf-id": "integer",
"state": "string",
"time-since-last-query-in-seconds": "integer",
"location": "integer",
"subscriber-id": "string",
"is-ip-enabled": "boolean",
"router-uptime-in-seconds": "integer",
"parent-ifhandle": "string",
"query-interval": "integer",
"configuration-mcast-vrf-error": "boolean",
"is-identity-present": "boolean",
"query-timeout": "integer",
"query-maximum-response-time": "integer",
"querier-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"igmp-version": "integer",
"las-ll-registration-count": "integer",
"is-interface-up": "boolean",
"mte-tuple-count": "integer",
"is-las-request": "boolean",
"prefix-length": "integer",
"las-null-update-count": "integer",
"is-querier": "boolean",
"robustness": "integer",
"las-unregistration-count": "integer",
"is-im-state-registered": "boolean",
"mtu": "integer",
"is-configurationverify": "boolean",
"time-since-last-report-in-seconds": "integer",
"configurationvrf-error": "boolean",
"host-version": "integer",
"group-joins": "integer"
}
}
]
}
IFRS-INTERFACE - Retrieve
Retrieve operation of resource: ifrs-interface
vrf-name
in path
string
ID of vrf-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"join-group-count": "integer",
"igmp-interface-entry": {
"las-ll-remove-update-count": "integer",
"las-ll-add-update-count": "integer",
"las-update-count": "integer",
"configurationvrf-set": "boolean",
"vrf-id": "integer",
"subscriber-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"vrf-state": "integer",
"last-member-query-interval": "integer",
"interface-name-xr": "string",
"is-las-registered": "boolean",
"group-leaves": "integer",
"is-router-enabled": "boolean",
"las-get-address-count": "integer",
"subscriber-mode": "integer",
"total-active-groups": "integer",
"configuration-mcast-vrf-set": "boolean",
"querier-uptime": "integer",
"proxy-interface": "string",
"is-subscriber": "boolean",
"mte-vrf-id": "integer",
"state": "string",
"time-since-last-query-in-seconds": "integer",
"location": "integer",
"subscriber-id": "string",
"is-ip-enabled": "boolean",
"router-uptime-in-seconds": "integer",
"parent-ifhandle": "string",
"query-interval": "integer",
"configuration-mcast-vrf-error": "boolean",
"is-identity-present": "boolean",
"query-timeout": "integer",
"query-maximum-response-time": "integer",
"querier-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"igmp-version": "integer",
"las-ll-registration-count": "integer",
"is-interface-up": "boolean",
"mte-tuple-count": "integer",
"is-las-request": "boolean",
"prefix-length": "integer",
"las-null-update-count": "integer",
"is-querier": "boolean",
"robustness": "integer",
"las-unregistration-count": "integer",
"is-im-state-registered": "boolean",
"mtu": "integer",
"is-configurationverify": "boolean",
"time-since-last-report-in-seconds": "integer",
"configurationvrf-error": "boolean",
"host-version": "integer",
"group-joins": "integer"
}
}
IGMP-INTERFACE-ENTRY - Retrieve
Retrieve operation of resource: igmp-interface-entry
vrf-name
in path
string
ID of vrf-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"las-ll-remove-update-count": "integer",
"las-ll-add-update-count": "integer",
"las-update-count": "integer",
"configurationvrf-set": "boolean",
"vrf-id": "integer",
"subscriber-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"vrf-state": "integer",
"last-member-query-interval": "integer",
"interface-name-xr": "string",
"is-las-registered": "boolean",
"group-leaves": "integer",
"is-router-enabled": "boolean",
"las-get-address-count": "integer",
"subscriber-mode": "integer",
"total-active-groups": "integer",
"configuration-mcast-vrf-set": "boolean",
"querier-uptime": "integer",
"proxy-interface": "string",
"is-subscriber": "boolean",
"mte-vrf-id": "integer",
"state": "string",
"time-since-last-query-in-seconds": "integer",
"location": "integer",
"subscriber-id": "string",
"is-ip-enabled": "boolean",
"router-uptime-in-seconds": "integer",
"parent-ifhandle": "string",
"query-interval": "integer",
"configuration-mcast-vrf-error": "boolean",
"is-identity-present": "boolean",
"query-timeout": "integer",
"query-maximum-response-time": "integer",
"querier-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"igmp-version": "integer",
"las-ll-registration-count": "integer",
"is-interface-up": "boolean",
"mte-tuple-count": "integer",
"is-las-request": "boolean",
"prefix-length": "integer",
"las-null-update-count": "integer",
"is-querier": "boolean",
"robustness": "integer",
"las-unregistration-count": "integer",
"is-im-state-registered": "boolean",
"mtu": "integer",
"is-configurationverify": "boolean",
"time-since-last-report-in-seconds": "integer",
"configurationvrf-error": "boolean",
"host-version": "integer",
"group-joins": "integer"
}
ADDRESS - Retrieve
Retrieve operation of resource: address
vrf-name
in path
string
ID of vrf-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
QUERIER-ADDRESS - Retrieve
Retrieve operation of resource: querier-address
vrf-name
in path
string
ID of vrf-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SUBSCRIBER-ADDRESS - Retrieve
Retrieve operation of resource: subscriber-address
vrf-name
in path
string
ID of vrf-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
TRAFFIC-COUNTERS - Retrieve
Retrieve operation of resource: traffic-counters
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"checksum-errors": "integer",
"auxillary-data-length-errors": "integer",
"input-mtrace": "integer",
"socket-errors": "integer",
"packet-manager-input-errors": "integer",
"packets-out": "integer",
"input-no-idb": "integer",
"output-no-parent-interface-handle": "integer",
"receive-socket-errors": "integer",
"output-leaves": "integer",
"no-socket-connection": "integer",
"bad-scope-errors": "integer",
"input-leaves": "integer",
"invalid-source-address-errors": "integer",
"get-packet-failure": "integer",
"input-dvmrp": "integer",
"miscellaneous-errors": "integer",
"elapsed-time": "integer",
"input-no-platform-support-mtrace": "integer",
"input-queries": "integer",
"output-pim": "integer",
"input-disabled-idb": "integer",
"packet-manager-output-errors": "integer",
"format-errors": "integer",
"packets-in": "integer",
"input-no-vrf-mtrace": "integer",
"input-no-assigned-vrf-id": "integer",
"input-reports": "integer",
"input-pim": "integer",
"input-martian-address": "integer",
"output-queries": "integer",
"input-no-vrf-in-idb": "integer",
"output-mtrace": "integer",
"output-reports": "integer",
"output-dvmrp": "integer"
}
GROUPS - Retrieve
Retrieve operation of resource: groups
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"group": [
{
"uptime": "integer",
"older-host-version1-timer": "integer",
"row-status": "string",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-added": "boolean",
"older-host-version2-timer": "integer",
"last-reporter": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"expiration-time": "string",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-suppressed": "boolean",
"is-self-join": "boolean",
"is-low-memory": "boolean",
"interface-name-xr": "string",
"router-filter-mode": "integer",
"explicit-tracking-enabled": "boolean"
}
]
}
GROUP - Retrieve
Retrieve operation of resource: group
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"uptime": "integer",
"older-host-version1-timer": "integer",
"row-status": "string",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-added": "boolean",
"older-host-version2-timer": "integer",
"last-reporter": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"expiration-time": "string",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-suppressed": "boolean",
"is-self-join": "boolean",
"is-low-memory": "boolean",
"interface-name-xr": "string",
"router-filter-mode": "integer",
"explicit-tracking-enabled": "boolean"
}
GROUP-ADDRESS-XR - Retrieve
Retrieve operation of resource: group-address-xr
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
LAST-REPORTER - Retrieve
Retrieve operation of resource: last-reporter
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SOURCE-ADDRESS - Retrieve
Retrieve operation of resource: source-address
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
GROUP-SUMMARY - Retrieve
Retrieve operation of resource: group-summary
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"group-count": "integer",
"groutes": "integer",
"sg-routes": "integer",
"is-low-memory": "boolean"
}
IFRS-INTERFACE-SUMMARY - Retrieve
Retrieve operation of resource: ifrs-interface-summary
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-count": "integer",
"configuration-count": "integer"
}
GLOBAL-INTERFACE-TABLE - Retrieve
Retrieve operation of resource: global-interface-table
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface": [
{
"interface-name": "string",
"las-ll-remove-update-count": "integer",
"las-ll-add-update-count": "integer",
"las-update-count": "integer",
"configurationvrf-set": "boolean",
"vrf-id": "integer",
"subscriber-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"vrf-state": "integer",
"last-member-query-interval": "integer",
"interface-name-xr": "string",
"is-las-registered": "boolean",
"group-leaves": "integer",
"is-router-enabled": "boolean",
"las-get-address-count": "integer",
"subscriber-mode": "integer",
"total-active-groups": "integer",
"configuration-mcast-vrf-set": "boolean",
"querier-uptime": "integer",
"proxy-interface": "string",
"is-subscriber": "boolean",
"mte-vrf-id": "integer",
"state": "string",
"time-since-last-query-in-seconds": "integer",
"location": "integer",
"subscriber-id": "string",
"is-ip-enabled": "boolean",
"router-uptime-in-seconds": "integer",
"parent-ifhandle": "string",
"query-interval": "integer",
"configuration-mcast-vrf-error": "boolean",
"is-identity-present": "boolean",
"query-timeout": "integer",
"query-maximum-response-time": "integer",
"querier-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"igmp-version": "integer",
"las-ll-registration-count": "integer",
"is-interface-up": "boolean",
"mte-tuple-count": "integer",
"is-las-request": "boolean",
"prefix-length": "integer",
"las-null-update-count": "integer",
"is-querier": "boolean",
"robustness": "integer",
"las-unregistration-count": "integer",
"is-im-state-registered": "boolean",
"mtu": "integer",
"is-configurationverify": "boolean",
"time-since-last-report-in-seconds": "integer",
"configurationvrf-error": "boolean",
"host-version": "integer",
"group-joins": "integer"
}
]
}
INTERFACE - Retrieve
Retrieve operation of resource: interface
vrf-name
in path
string
ID of vrf-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"las-ll-remove-update-count": "integer",
"las-ll-add-update-count": "integer",
"las-update-count": "integer",
"configurationvrf-set": "boolean",
"vrf-id": "integer",
"subscriber-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"vrf-state": "integer",
"last-member-query-interval": "integer",
"interface-name-xr": "string",
"is-las-registered": "boolean",
"group-leaves": "integer",
"is-router-enabled": "boolean",
"las-get-address-count": "integer",
"subscriber-mode": "integer",
"total-active-groups": "integer",
"configuration-mcast-vrf-set": "boolean",
"querier-uptime": "integer",
"proxy-interface": "string",
"is-subscriber": "boolean",
"mte-vrf-id": "integer",
"state": "string",
"time-since-last-query-in-seconds": "integer",
"location": "integer",
"subscriber-id": "string",
"is-ip-enabled": "boolean",
"router-uptime-in-seconds": "integer",
"parent-ifhandle": "string",
"query-interval": "integer",
"configuration-mcast-vrf-error": "boolean",
"is-identity-present": "boolean",
"query-timeout": "integer",
"query-maximum-response-time": "integer",
"querier-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"igmp-version": "integer",
"las-ll-registration-count": "integer",
"is-interface-up": "boolean",
"mte-tuple-count": "integer",
"is-las-request": "boolean",
"prefix-length": "integer",
"las-null-update-count": "integer",
"is-querier": "boolean",
"robustness": "integer",
"las-unregistration-count": "integer",
"is-im-state-registered": "boolean",
"mtu": "integer",
"is-configurationverify": "boolean",
"time-since-last-report-in-seconds": "integer",
"configurationvrf-error": "boolean",
"host-version": "integer",
"group-joins": "integer"
}
ADDRESS - Retrieve
Retrieve operation of resource: address
vrf-name
in path
string
ID of vrf-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
QUERIER-ADDRESS - Retrieve
Retrieve operation of resource: querier-address
vrf-name
in path
string
ID of vrf-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SUBSCRIBER-ADDRESS - Retrieve
Retrieve operation of resource: subscriber-address
vrf-name
in path
string
ID of vrf-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SSM-MAP-DETAILS - Retrieve
Retrieve operation of resource: ssm-map-details
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ssm-map-detail": [
{
"response-pending": "boolean",
"query-interval": "integer",
"map-info": {
"source-counts": "integer",
"map-type": "integer",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
},
"expiration-time": "integer",
"sources": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"elapsed-time": "integer"
}
]
}
SSM-MAP-DETAIL - Retrieve
Retrieve operation of resource: ssm-map-detail
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"response-pending": "boolean",
"query-interval": "integer",
"map-info": {
"source-counts": "integer",
"map-type": "integer",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
},
"expiration-time": "integer",
"sources": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"elapsed-time": "integer"
}
MAP-INFO - Retrieve
Retrieve operation of resource: map-info
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"source-counts": "integer",
"map-type": "integer",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
GROUP-ADDRESS-XR - Retrieve
Retrieve operation of resource: group-address-xr
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SOURCES - Retrieve
Retrieve operation of resource: sources
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
INTERFACE-STATE-OFFS - Retrieve
Retrieve operation of resource: interface-state-offs
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-state-off": [
{
"las-ll-remove-update-count": "integer",
"las-ll-add-update-count": "integer",
"las-update-count": "integer",
"configurationvrf-set": "boolean",
"vrf-id": "integer",
"subscriber-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"vrf-state": "integer",
"last-member-query-interval": "integer",
"interface-name-xr": "string",
"is-las-registered": "boolean",
"group-leaves": "integer",
"is-router-enabled": "boolean",
"las-get-address-count": "integer",
"subscriber-mode": "integer",
"total-active-groups": "integer",
"configuration-mcast-vrf-set": "boolean",
"querier-uptime": "integer",
"proxy-interface": "string",
"is-subscriber": "boolean",
"mte-vrf-id": "integer",
"state": "string",
"time-since-last-query-in-seconds": "integer",
"location": "integer",
"subscriber-id": "string",
"is-ip-enabled": "boolean",
"router-uptime-in-seconds": "integer",
"parent-ifhandle": "string",
"query-interval": "integer",
"configuration-mcast-vrf-error": "boolean",
"is-identity-present": "boolean",
"query-timeout": "integer",
"query-maximum-response-time": "integer",
"querier-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"igmp-version": "integer",
"las-ll-registration-count": "integer",
"is-interface-up": "boolean",
"mte-tuple-count": "integer",
"is-las-request": "boolean",
"prefix-length": "integer",
"las-null-update-count": "integer",
"is-querier": "boolean",
"robustness": "integer",
"las-unregistration-count": "integer",
"is-im-state-registered": "boolean",
"mtu": "integer",
"is-configurationverify": "boolean",
"time-since-last-report-in-seconds": "integer",
"configurationvrf-error": "boolean",
"host-version": "integer",
"group-joins": "integer"
}
]
}
INTERFACE-STATE-OFF - Retrieve
Retrieve operation of resource: interface-state-off
vrf-name
in path
string
ID of vrf-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"las-ll-remove-update-count": "integer",
"las-ll-add-update-count": "integer",
"las-update-count": "integer",
"configurationvrf-set": "boolean",
"vrf-id": "integer",
"subscriber-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"vrf-state": "integer",
"last-member-query-interval": "integer",
"interface-name-xr": "string",
"is-las-registered": "boolean",
"group-leaves": "integer",
"is-router-enabled": "boolean",
"las-get-address-count": "integer",
"subscriber-mode": "integer",
"total-active-groups": "integer",
"configuration-mcast-vrf-set": "boolean",
"querier-uptime": "integer",
"proxy-interface": "string",
"is-subscriber": "boolean",
"mte-vrf-id": "integer",
"state": "string",
"time-since-last-query-in-seconds": "integer",
"location": "integer",
"subscriber-id": "string",
"is-ip-enabled": "boolean",
"router-uptime-in-seconds": "integer",
"parent-ifhandle": "string",
"query-interval": "integer",
"configuration-mcast-vrf-error": "boolean",
"is-identity-present": "boolean",
"query-timeout": "integer",
"query-maximum-response-time": "integer",
"querier-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"igmp-version": "integer",
"las-ll-registration-count": "integer",
"is-interface-up": "boolean",
"mte-tuple-count": "integer",
"is-las-request": "boolean",
"prefix-length": "integer",
"las-null-update-count": "integer",
"is-querier": "boolean",
"robustness": "integer",
"las-unregistration-count": "integer",
"is-im-state-registered": "boolean",
"mtu": "integer",
"is-configurationverify": "boolean",
"time-since-last-report-in-seconds": "integer",
"configurationvrf-error": "boolean",
"host-version": "integer",
"group-joins": "integer"
}
ADDRESS - Retrieve
Retrieve operation of resource: address
vrf-name
in path
string
ID of vrf-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
QUERIER-ADDRESS - Retrieve
Retrieve operation of resource: querier-address
vrf-name
in path
string
ID of vrf-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SUBSCRIBER-ADDRESS - Retrieve
Retrieve operation of resource: subscriber-address
vrf-name
in path
string
ID of vrf-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
PROCESS - Retrieve
Retrieve operation of resource: process
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"amt-gateways": {
"amt-gateway": [
{
"amt-nonce": "integer",
"amtgw": "string",
"mem-upd-in": "integer",
"key-len": "integer",
"mem-upd-out": "integer",
"amtnh": "integer",
"amt-port": "integer",
"idb": "integer"
}
]
},
"unicast-qos-adjust-stats": {
"is-qos-s-sweeped": "boolean",
"batches": "integer",
"send-errors": "integer",
"last-download-time": "integer",
"sent-resync-bulks": "integer",
"is-resync-required": "boolean",
"queues": "integer",
"is-resync-start-sent": "boolean",
"send-partial-errors": "integer",
"last-sweep-time": "integer",
"send-success": "integer",
"is-resync-received": "boolean",
"add-to-batches": "integer",
"received-resync-requests": "integer",
"send-comm-errors": "integer",
"delete-to-batches": "integer"
},
"amt-summary": {
"gateway-count": "integer",
"prefix-length": "integer",
"anycast-prefix": "string",
"query-interval": "integer",
"relay-address": "string",
"tos": "integer",
"mtu": "integer",
"tunnel-count": "integer",
"tunnel-configured-maximum": "integer",
"ttl": "integer",
"is-acl-configured": "boolean",
"max-gateway": "integer",
"is-gateway-simulation": "boolean",
"is-ou-of-resource": "boolean"
},
"nsf": {
"last-nsf-off": "string",
"last-icd-notif-recv-min": "string",
"multicast-nsf-time-left": "integer",
"is-multicast-nsf-active": "boolean",
"last-icd-notif-recv": "string",
"multicast-nsf-timeout": "integer",
"respawn-count": "integer",
"last-nsf-on-min": "string",
"last-nsf-on": "string",
"last-nsf-off-min": "string"
},
"bvi-statistics": {
"tx-unknown-mrouter-msg": "integer",
"send-blocks": "integer",
"tx-protocol-buffers": "integer",
"rx-ipc-close-notif": "integer",
"rx-ipc-publish-notif": "integer",
"wtx-msg-proto-sent": "integer",
"rx-igmp-packet-success": "integer",
"rx-ipc-open-notif": "integer",
"rx-sweep-mrouter-msg": "integer",
"rx-ipc-lwm-notif": "integer",
"wtx-msg-drop-nomem": "integer",
"rx-delete-mrouter-msg": "integer",
"wtx-msg-freed": "integer",
"rx-ipc-q-full-notif": "integer",
"receive-buffers": "integer",
"rx-add-mrouter-msg": "integer",
"tx-add-mrouter-msg": "integer",
"rx-ipc-input-wait-notif": "integer",
"tx-sweep-mrouter-msg": "integer",
"tx-unknown-buffers": "integer",
"rx-ipc-send-status-notif": "integer",
"rx-ipc-output-notif": "integer",
"wtx-msg-drop-dc": "integer",
"null-buffer-handles": "integer",
"tx-delete-mrouter-msg": "integer",
"rx-ipc-error-notif": "integer",
"rx-unknown-mrouter-msg": "integer",
"release-buffers": "integer",
"release-fail-buffers": "integer",
"tx-buffer-errors": "integer",
"tx-mrouter-buffers": "integer",
"tx-buffers": "integer",
"wtx-msg-recvd": "integer",
"wtx-msg-sent": "integer",
"rx-ipc-connect-notif": "integer"
},
"nsr": {
"collab-conv-done": "boolean"
}
}
AMT-SUMMARY - Retrieve
Retrieve operation of resource: amt-summary
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"gateway-count": "integer",
"prefix-length": "integer",
"anycast-prefix": "string",
"query-interval": "integer",
"relay-address": "string",
"tos": "integer",
"mtu": "integer",
"tunnel-count": "integer",
"tunnel-configured-maximum": "integer",
"ttl": "integer",
"is-acl-configured": "boolean",
"max-gateway": "integer",
"is-gateway-simulation": "boolean",
"is-ou-of-resource": "boolean"
}
NSR - Retrieve
Retrieve operation of resource: nsr
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"collab-conv-done": "boolean",
"rmf-notification-done": "boolean",
"last-rmf-not-ready": "integer",
"count-proc-connection-dn": "integer",
"count-rmf-ready": "integer",
"state": "integer",
"count-proc-connection-up": "integer",
"last-proc": "integer",
"count-rmf-not-ready": "integer",
"last-proc-connection-up": "integer",
"last-proc-connection-dn": "integer",
"last-rmf-ready": "integer",
"partner-proc-connected": "boolean"
}
AMT-GATEWAYS - Retrieve
Retrieve operation of resource: amt-gateways
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"amt-gateway": [
{
"amt-nonce": "integer",
"amtgw": "string",
"mem-upd-in": "integer",
"key-len": "integer",
"mem-upd-out": "integer",
"amtnh": "integer",
"amt-port": "integer",
"idb": "integer"
}
]
}
AMT-GATEWAY - Retrieve
Retrieve operation of resource: amt-gateway
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"amt-nonce": "integer",
"amtgw": "string",
"mem-upd-in": "integer",
"key-len": "integer",
"mem-upd-out": "integer",
"amtnh": "integer",
"amt-port": "integer",
"idb": "integer"
}
UNICAST-QOS-ADJUST-STATS - Retrieve
Retrieve operation of resource: unicast-qos-adjust-stats
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-qos-s-sweeped": "boolean",
"batches": "integer",
"send-errors": "integer",
"last-download-time": "integer",
"sent-resync-bulks": "integer",
"is-resync-required": "boolean",
"queues": "integer",
"is-resync-start-sent": "boolean",
"send-partial-errors": "integer",
"last-sweep-time": "integer",
"send-success": "integer",
"is-resync-received": "boolean",
"add-to-batches": "integer",
"received-resync-requests": "integer",
"send-comm-errors": "integer",
"delete-to-batches": "integer"
}
BVI-STATISTICS - Retrieve
Retrieve operation of resource: bvi-statistics
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"tx-unknown-mrouter-msg": "integer",
"send-blocks": "integer",
"tx-protocol-buffers": "integer",
"rx-ipc-close-notif": "integer",
"rx-ipc-publish-notif": "integer",
"wtx-msg-proto-sent": "integer",
"rx-igmp-packet-success": "integer",
"rx-ipc-open-notif": "integer",
"rx-sweep-mrouter-msg": "integer",
"rx-ipc-lwm-notif": "integer",
"wtx-msg-drop-nomem": "integer",
"rx-delete-mrouter-msg": "integer",
"wtx-msg-freed": "integer",
"rx-ipc-q-full-notif": "integer",
"receive-buffers": "integer",
"rx-add-mrouter-msg": "integer",
"tx-add-mrouter-msg": "integer",
"rx-ipc-input-wait-notif": "integer",
"tx-sweep-mrouter-msg": "integer",
"tx-unknown-buffers": "integer",
"rx-ipc-send-status-notif": "integer",
"rx-ipc-output-notif": "integer",
"wtx-msg-drop-dc": "integer",
"null-buffer-handles": "integer",
"tx-delete-mrouter-msg": "integer",
"rx-ipc-error-notif": "integer",
"rx-unknown-mrouter-msg": "integer",
"release-buffers": "integer",
"release-fail-buffers": "integer",
"tx-buffer-errors": "integer",
"tx-mrouter-buffers": "integer",
"tx-buffers": "integer",
"wtx-msg-recvd": "integer",
"wtx-msg-sent": "integer",
"rx-ipc-connect-notif": "integer"
}
NSF - Retrieve
Retrieve operation of resource: nsf
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"last-nsf-off": "string",
"last-icd-notif-recv-min": "string",
"multicast-nsf-time-left": "integer",
"is-multicast-nsf-active": "boolean",
"last-icd-notif-recv": "string",
"multicast-nsf-timeout": "integer",
"respawn-count": "integer",
"last-nsf-on-min": "string",
"last-nsf-on": "string",
"last-nsf-off-min": "string"
}
DEFAULT-CONTEXT - Retrieve
Retrieve operation of resource: default-context
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-state-offs": {
"interface-state-off": [
{
"interface-name": "string",
"las-ll-remove-update-count": "integer",
"las-ll-add-update-count": "integer",
"las-update-count": "integer",
"configurationvrf-set": "boolean",
"vrf-id": "integer",
"subscriber-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"vrf-state": "integer",
"last-member-query-interval": "integer",
"interface-name-xr": "string",
"is-las-registered": "boolean",
"group-leaves": "integer",
"is-router-enabled": "boolean",
"las-get-address-count": "integer",
"subscriber-mode": "integer",
"total-active-groups": "integer",
"configuration-mcast-vrf-set": "boolean",
"querier-uptime": "integer",
"proxy-interface": "string",
"is-subscriber": "boolean",
"mte-vrf-id": "integer",
"state": "string",
"time-since-last-query-in-seconds": "integer",
"location": "integer",
"subscriber-id": "string",
"is-ip-enabled": "boolean",
"router-uptime-in-seconds": "integer",
"parent-ifhandle": "string",
"query-interval": "integer",
"configuration-mcast-vrf-error": "boolean",
"is-identity-present": "boolean",
"query-timeout": "integer",
"query-maximum-response-time": "integer",
"querier-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"igmp-version": "integer",
"las-ll-registration-count": "integer",
"is-interface-up": "boolean",
"mte-tuple-count": "integer",
"is-las-request": "boolean",
"prefix-length": "integer",
"las-null-update-count": "integer",
"is-querier": "boolean",
"robustness": "integer",
"las-unregistration-count": "integer",
"is-im-state-registered": "boolean",
"mtu": "integer",
"is-configurationverify": "boolean",
"time-since-last-report-in-seconds": "integer",
"configurationvrf-error": "boolean",
"host-version": "integer",
"group-joins": "integer"
}
]
}
}
SUMMARY - Retrieve
Retrieve operation of resource: summary
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"group-count": "integer",
"disabled-interface-count": "integer",
"group-limit": "integer",
"supported-interfaces": "integer",
"robustness": "integer",
"is-disabled": "boolean",
"enabled-interface-count": "integer",
"node-low-memory": "boolean",
"unsupported-interfaces": "integer",
"tunnel-mte-config-count": "integer",
"interface": [
{
"group-count": "integer",
"parent-ifhandle": "string",
"router-uptime-in-seconds": "integer",
"interface-name": "string",
"group-limit": "integer",
"on-off": "boolean",
"time-since-last-report-in-seconds": "integer",
"time-since-last-query-in-seconds": "integer"
}
]
}
INTERFACE - Retrieve
Retrieve operation of resource: interface
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"group-count": "integer",
"parent-ifhandle": "string",
"router-uptime-in-seconds": "integer",
"interface-name": "string",
"group-limit": "integer",
"on-off": "boolean",
"time-since-last-report-in-seconds": "integer",
"time-since-last-query-in-seconds": "integer"
}
INTERFACE-STATE-ONS - Retrieve
Retrieve operation of resource: interface-state-ons
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-state-on": [
{
"las-ll-remove-update-count": "integer",
"las-ll-add-update-count": "integer",
"las-update-count": "integer",
"configurationvrf-set": "boolean",
"vrf-id": "integer",
"subscriber-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"vrf-state": "integer",
"last-member-query-interval": "integer",
"interface-name-xr": "string",
"is-las-registered": "boolean",
"group-leaves": "integer",
"is-router-enabled": "boolean",
"las-get-address-count": "integer",
"subscriber-mode": "integer",
"total-active-groups": "integer",
"configuration-mcast-vrf-set": "boolean",
"querier-uptime": "integer",
"proxy-interface": "string",
"is-subscriber": "boolean",
"mte-vrf-id": "integer",
"state": "string",
"time-since-last-query-in-seconds": "integer",
"location": "integer",
"subscriber-id": "string",
"is-ip-enabled": "boolean",
"router-uptime-in-seconds": "integer",
"parent-ifhandle": "string",
"query-interval": "integer",
"configuration-mcast-vrf-error": "boolean",
"is-identity-present": "boolean",
"query-timeout": "integer",
"query-maximum-response-time": "integer",
"querier-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"igmp-version": "integer",
"las-ll-registration-count": "integer",
"is-interface-up": "boolean",
"mte-tuple-count": "integer",
"is-las-request": "boolean",
"prefix-length": "integer",
"las-null-update-count": "integer",
"is-querier": "boolean",
"robustness": "integer",
"las-unregistration-count": "integer",
"is-im-state-registered": "boolean",
"mtu": "integer",
"is-configurationverify": "boolean",
"time-since-last-report-in-seconds": "integer",
"configurationvrf-error": "boolean",
"host-version": "integer",
"group-joins": "integer"
}
]
}
INTERFACE-STATE-ON - Retrieve
Retrieve operation of resource: interface-state-on
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"las-ll-remove-update-count": "integer",
"las-ll-add-update-count": "integer",
"las-update-count": "integer",
"configurationvrf-set": "boolean",
"vrf-id": "integer",
"subscriber-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"vrf-state": "integer",
"last-member-query-interval": "integer",
"interface-name-xr": "string",
"is-las-registered": "boolean",
"group-leaves": "integer",
"is-router-enabled": "boolean",
"las-get-address-count": "integer",
"subscriber-mode": "integer",
"total-active-groups": "integer",
"configuration-mcast-vrf-set": "boolean",
"querier-uptime": "integer",
"proxy-interface": "string",
"is-subscriber": "boolean",
"mte-vrf-id": "integer",
"state": "string",
"time-since-last-query-in-seconds": "integer",
"location": "integer",
"subscriber-id": "string",
"is-ip-enabled": "boolean",
"router-uptime-in-seconds": "integer",
"parent-ifhandle": "string",
"query-interval": "integer",
"configuration-mcast-vrf-error": "boolean",
"is-identity-present": "boolean",
"query-timeout": "integer",
"query-maximum-response-time": "integer",
"querier-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"igmp-version": "integer",
"las-ll-registration-count": "integer",
"is-interface-up": "boolean",
"mte-tuple-count": "integer",
"is-las-request": "boolean",
"prefix-length": "integer",
"las-null-update-count": "integer",
"is-querier": "boolean",
"robustness": "integer",
"las-unregistration-count": "integer",
"is-im-state-registered": "boolean",
"mtu": "integer",
"is-configurationverify": "boolean",
"time-since-last-report-in-seconds": "integer",
"configurationvrf-error": "boolean",
"host-version": "integer",
"group-joins": "integer"
}
ADDRESS - Retrieve
Retrieve operation of resource: address
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
QUERIER-ADDRESS - Retrieve
Retrieve operation of resource: querier-address
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SUBSCRIBER-ADDRESS - Retrieve
Retrieve operation of resource: subscriber-address
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
DETAIL-GROUPS - Retrieve
Retrieve operation of resource: detail-groups
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"detail-group": [
{
"source": [
{
"uptime": "integer",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"expiration-time": "string",
"is-local": "boolean",
"is-forward": "boolean",
"is-added": "boolean",
"flags": "string",
"is-remote": "boolean",
"is-we-report": "boolean"
}
],
"is-router-exclude-mode": "boolean",
"group-info": {
"uptime": "integer",
"older-host-version1-timer": "integer",
"row-status": "string",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-added": "boolean",
"older-host-version2-timer": "integer",
"last-reporter": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"expiration-time": "string",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-suppressed": "boolean",
"is-self-join": "boolean",
"is-low-memory": "boolean",
"interface-name-xr": "string",
"router-filter-mode": "integer",
"explicit-tracking-enabled": "boolean"
},
"is-host-exclude-mode": "boolean"
}
]
}
DETAIL-GROUP - Retrieve
Retrieve operation of resource: detail-group
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"source": [
{
"uptime": "integer",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"expiration-time": "string",
"is-local": "boolean",
"is-forward": "boolean",
"is-added": "boolean",
"flags": "string",
"is-remote": "boolean",
"is-we-report": "boolean"
}
],
"is-router-exclude-mode": "boolean",
"group-info": {
"uptime": "integer",
"older-host-version1-timer": "integer",
"row-status": "string",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-added": "boolean",
"older-host-version2-timer": "integer",
"last-reporter": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"expiration-time": "string",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-suppressed": "boolean",
"is-self-join": "boolean",
"is-low-memory": "boolean",
"interface-name-xr": "string",
"router-filter-mode": "integer",
"explicit-tracking-enabled": "boolean"
},
"is-host-exclude-mode": "boolean"
}
GROUP-INFO - Retrieve
Retrieve operation of resource: group-info
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"uptime": "integer",
"older-host-version1-timer": "integer",
"row-status": "string",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-added": "boolean",
"older-host-version2-timer": "integer",
"last-reporter": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"expiration-time": "string",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-suppressed": "boolean",
"is-self-join": "boolean",
"is-low-memory": "boolean",
"interface-name-xr": "string",
"router-filter-mode": "integer",
"explicit-tracking-enabled": "boolean"
}
GROUP-ADDRESS-XR - Retrieve
Retrieve operation of resource: group-address-xr
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
LAST-REPORTER - Retrieve
Retrieve operation of resource: last-reporter
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SOURCE-ADDRESS - Retrieve
Retrieve operation of resource: source-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SOURCE - Retrieve
Retrieve operation of resource: source
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"uptime": "integer",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"expiration-time": "string",
"is-local": "boolean",
"is-forward": "boolean",
"is-added": "boolean",
"flags": "string",
"is-remote": "boolean",
"is-we-report": "boolean"
}
SOURCE-ADDRESS - Retrieve
Retrieve operation of resource: source-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
NON-ACTIVE-GROUPS - Retrieve
Retrieve operation of resource: non-active-groups
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"non-active-groups": [
{
"interface": "string",
"group-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"reason-for-non-activity": "string",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
}
NON-ACTIVE-GROUPS - Retrieve
Retrieve operation of resource: non-active-groups
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface": "string",
"group-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"reason-for-non-activity": "string",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
GROUP-ADDRESS - Retrieve
Retrieve operation of resource: group-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SOURCE-ADDRESS - Retrieve
Retrieve operation of resource: source-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SSM-MAPS - Retrieve
Retrieve operation of resource: ssm-maps
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ssm-map": [
{
"source-counts": "integer",
"map-type": "integer",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
}
SSM-MAP - Retrieve
Retrieve operation of resource: ssm-map
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"source-counts": "integer",
"map-type": "integer",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
GROUP-ADDRESS-XR - Retrieve
Retrieve operation of resource: group-address-xr
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
EXPLICIT-GROUPS - Retrieve
Retrieve operation of resource: explicit-groups
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"explicit-group": [
{
"exclude-hosts": "integer",
"host": [
{
"uptime": "integer",
"source-address": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"is-exclude": "boolean",
"expiration-time": "integer",
"source-count": "integer",
"address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
],
"include-hosts": "integer",
"group-info": {
"uptime": "integer",
"older-host-version1-timer": "integer",
"row-status": "string",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-added": "boolean",
"older-host-version2-timer": "integer",
"last-reporter": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"expiration-time": "string",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-suppressed": "boolean",
"is-self-join": "boolean",
"is-low-memory": "boolean",
"interface-name-xr": "string",
"router-filter-mode": "integer",
"explicit-tracking-enabled": "boolean"
}
}
]
}
EXPLICIT-GROUP - Retrieve
Retrieve operation of resource: explicit-group
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"exclude-hosts": "integer",
"host": [
{
"uptime": "integer",
"source-address": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"is-exclude": "boolean",
"expiration-time": "integer",
"source-count": "integer",
"address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
],
"include-hosts": "integer",
"group-info": {
"uptime": "integer",
"older-host-version1-timer": "integer",
"row-status": "string",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-added": "boolean",
"older-host-version2-timer": "integer",
"last-reporter": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"expiration-time": "string",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-suppressed": "boolean",
"is-self-join": "boolean",
"is-low-memory": "boolean",
"interface-name-xr": "string",
"router-filter-mode": "integer",
"explicit-tracking-enabled": "boolean"
}
}
GROUP-INFO - Retrieve
Retrieve operation of resource: group-info
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"uptime": "integer",
"older-host-version1-timer": "integer",
"row-status": "string",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-added": "boolean",
"older-host-version2-timer": "integer",
"last-reporter": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"expiration-time": "string",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-suppressed": "boolean",
"is-self-join": "boolean",
"is-low-memory": "boolean",
"interface-name-xr": "string",
"router-filter-mode": "integer",
"explicit-tracking-enabled": "boolean"
}
GROUP-ADDRESS-XR - Retrieve
Retrieve operation of resource: group-address-xr
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
LAST-REPORTER - Retrieve
Retrieve operation of resource: last-reporter
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SOURCE-ADDRESS - Retrieve
Retrieve operation of resource: source-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
HOST - Retrieve
Retrieve operation of resource: host
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"uptime": "integer",
"source-address": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"is-exclude": "boolean",
"expiration-time": "integer",
"source-count": "integer",
"address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
ADDRESS - Retrieve
Retrieve operation of resource: address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SOURCE-ADDRESS - Retrieve
Retrieve operation of resource: source-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
INTERFACE-TABLE - Retrieve
Retrieve operation of resource: interface-table
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface": [
{
"interface-name": "string",
"las-ll-remove-update-count": "integer",
"las-ll-add-update-count": "integer",
"las-update-count": "integer",
"configurationvrf-set": "boolean",
"vrf-id": "integer",
"subscriber-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"vrf-state": "integer",
"last-member-query-interval": "integer",
"interface-name-xr": "string",
"is-las-registered": "boolean",
"group-leaves": "integer",
"is-router-enabled": "boolean",
"las-get-address-count": "integer",
"subscriber-mode": "integer",
"total-active-groups": "integer",
"configuration-mcast-vrf-set": "boolean",
"querier-uptime": "integer",
"proxy-interface": "string",
"is-subscriber": "boolean",
"mte-vrf-id": "integer",
"state": "string",
"time-since-last-query-in-seconds": "integer",
"location": "integer",
"subscriber-id": "string",
"is-ip-enabled": "boolean",
"router-uptime-in-seconds": "integer",
"parent-ifhandle": "string",
"query-interval": "integer",
"configuration-mcast-vrf-error": "boolean",
"is-identity-present": "boolean",
"query-timeout": "integer",
"query-maximum-response-time": "integer",
"querier-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"igmp-version": "integer",
"las-ll-registration-count": "integer",
"is-interface-up": "boolean",
"mte-tuple-count": "integer",
"is-las-request": "boolean",
"prefix-length": "integer",
"las-null-update-count": "integer",
"is-querier": "boolean",
"robustness": "integer",
"las-unregistration-count": "integer",
"is-im-state-registered": "boolean",
"mtu": "integer",
"is-configurationverify": "boolean",
"time-since-last-report-in-seconds": "integer",
"configurationvrf-error": "boolean",
"host-version": "integer",
"group-joins": "integer"
}
]
}
INTERFACE - Retrieve
Retrieve operation of resource: interface
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"las-ll-remove-update-count": "integer",
"las-ll-add-update-count": "integer",
"las-update-count": "integer",
"configurationvrf-set": "boolean",
"vrf-id": "integer",
"subscriber-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"vrf-state": "integer",
"last-member-query-interval": "integer",
"interface-name-xr": "string",
"is-las-registered": "boolean",
"group-leaves": "integer",
"is-router-enabled": "boolean",
"las-get-address-count": "integer",
"subscriber-mode": "integer",
"total-active-groups": "integer",
"configuration-mcast-vrf-set": "boolean",
"querier-uptime": "integer",
"proxy-interface": "string",
"is-subscriber": "boolean",
"mte-vrf-id": "integer",
"state": "string",
"time-since-last-query-in-seconds": "integer",
"location": "integer",
"subscriber-id": "string",
"is-ip-enabled": "boolean",
"router-uptime-in-seconds": "integer",
"parent-ifhandle": "string",
"query-interval": "integer",
"configuration-mcast-vrf-error": "boolean",
"is-identity-present": "boolean",
"query-timeout": "integer",
"query-maximum-response-time": "integer",
"querier-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"igmp-version": "integer",
"las-ll-registration-count": "integer",
"is-interface-up": "boolean",
"mte-tuple-count": "integer",
"is-las-request": "boolean",
"prefix-length": "integer",
"las-null-update-count": "integer",
"is-querier": "boolean",
"robustness": "integer",
"las-unregistration-count": "integer",
"is-im-state-registered": "boolean",
"mtu": "integer",
"is-configurationverify": "boolean",
"time-since-last-report-in-seconds": "integer",
"configurationvrf-error": "boolean",
"host-version": "integer",
"group-joins": "integer"
}
ADDRESS - Retrieve
Retrieve operation of resource: address
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
QUERIER-ADDRESS - Retrieve
Retrieve operation of resource: querier-address
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SUBSCRIBER-ADDRESS - Retrieve
Retrieve operation of resource: subscriber-address
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
INTERFACE-UNICAST-QOS-ADJUSTS - Retrieve
Retrieve operation of resource: interface-unicast-qos-adjusts
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-unicast-qos-adjust": [
{
"is-virtual-access": "boolean",
"rate": "integer",
"rate-increments": "integer",
"rate-decrements": "integer",
"update": [
{
"is-add": "boolean",
"group-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"received-time": "integer",
"weight": "integer",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
}
]
}
INTERFACE-UNICAST-QOS-ADJUST - Retrieve
Retrieve operation of resource: interface-unicast-qos-adjust
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-virtual-access": "boolean",
"rate": "integer",
"rate-increments": "integer",
"rate-decrements": "integer",
"update": [
{
"is-add": "boolean",
"group-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"received-time": "integer",
"weight": "integer",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
}
UPDATE - Retrieve
Retrieve operation of resource: update
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-add": "boolean",
"group-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"received-time": "integer",
"weight": "integer",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
SOURCE-ADDRESS - Retrieve
Retrieve operation of resource: source-address
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
GROUP-ADDRESS - Retrieve
Retrieve operation of resource: group-address
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
RANGES - Retrieve
Retrieve operation of resource: ranges
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"range": [
{
"is-stale": "boolean",
"protocol": "string",
"prefix-length": "integer",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
}
RANGE - Retrieve
Retrieve operation of resource: range
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-stale": "boolean",
"protocol": "string",
"prefix-length": "integer",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
GROUP-ADDRESS-XR - Retrieve
Retrieve operation of resource: group-address-xr
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
IFRS-INTERFACES - Retrieve
Retrieve operation of resource: ifrs-interfaces
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ifrs-interface": [
{
"join-group-count": "integer",
"igmp-interface-entry": {
"las-ll-remove-update-count": "integer",
"las-ll-add-update-count": "integer",
"las-update-count": "integer",
"configurationvrf-set": "boolean",
"vrf-id": "integer",
"subscriber-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"vrf-state": "integer",
"last-member-query-interval": "integer",
"interface-name-xr": "string",
"is-las-registered": "boolean",
"group-leaves": "integer",
"is-router-enabled": "boolean",
"las-get-address-count": "integer",
"subscriber-mode": "integer",
"total-active-groups": "integer",
"configuration-mcast-vrf-set": "boolean",
"querier-uptime": "integer",
"proxy-interface": "string",
"is-subscriber": "boolean",
"mte-vrf-id": "integer",
"state": "string",
"time-since-last-query-in-seconds": "integer",
"location": "integer",
"subscriber-id": "string",
"is-ip-enabled": "boolean",
"router-uptime-in-seconds": "integer",
"parent-ifhandle": "string",
"query-interval": "integer",
"configuration-mcast-vrf-error": "boolean",
"is-identity-present": "boolean",
"query-timeout": "integer",
"query-maximum-response-time": "integer",
"querier-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"igmp-version": "integer",
"las-ll-registration-count": "integer",
"is-interface-up": "boolean",
"mte-tuple-count": "integer",
"is-las-request": "boolean",
"prefix-length": "integer",
"las-null-update-count": "integer",
"is-querier": "boolean",
"robustness": "integer",
"las-unregistration-count": "integer",
"is-im-state-registered": "boolean",
"mtu": "integer",
"is-configurationverify": "boolean",
"time-since-last-report-in-seconds": "integer",
"configurationvrf-error": "boolean",
"host-version": "integer",
"group-joins": "integer"
}
}
]
}
IFRS-INTERFACE - Retrieve
Retrieve operation of resource: ifrs-interface
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"join-group-count": "integer",
"igmp-interface-entry": {
"las-ll-remove-update-count": "integer",
"las-ll-add-update-count": "integer",
"las-update-count": "integer",
"configurationvrf-set": "boolean",
"vrf-id": "integer",
"subscriber-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"vrf-state": "integer",
"last-member-query-interval": "integer",
"interface-name-xr": "string",
"is-las-registered": "boolean",
"group-leaves": "integer",
"is-router-enabled": "boolean",
"las-get-address-count": "integer",
"subscriber-mode": "integer",
"total-active-groups": "integer",
"configuration-mcast-vrf-set": "boolean",
"querier-uptime": "integer",
"proxy-interface": "string",
"is-subscriber": "boolean",
"mte-vrf-id": "integer",
"state": "string",
"time-since-last-query-in-seconds": "integer",
"location": "integer",
"subscriber-id": "string",
"is-ip-enabled": "boolean",
"router-uptime-in-seconds": "integer",
"parent-ifhandle": "string",
"query-interval": "integer",
"configuration-mcast-vrf-error": "boolean",
"is-identity-present": "boolean",
"query-timeout": "integer",
"query-maximum-response-time": "integer",
"querier-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"igmp-version": "integer",
"las-ll-registration-count": "integer",
"is-interface-up": "boolean",
"mte-tuple-count": "integer",
"is-las-request": "boolean",
"prefix-length": "integer",
"las-null-update-count": "integer",
"is-querier": "boolean",
"robustness": "integer",
"las-unregistration-count": "integer",
"is-im-state-registered": "boolean",
"mtu": "integer",
"is-configurationverify": "boolean",
"time-since-last-report-in-seconds": "integer",
"configurationvrf-error": "boolean",
"host-version": "integer",
"group-joins": "integer"
}
}
IGMP-INTERFACE-ENTRY - Retrieve
Retrieve operation of resource: igmp-interface-entry
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"las-ll-remove-update-count": "integer",
"las-ll-add-update-count": "integer",
"las-update-count": "integer",
"configurationvrf-set": "boolean",
"vrf-id": "integer",
"subscriber-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"vrf-state": "integer",
"last-member-query-interval": "integer",
"interface-name-xr": "string",
"is-las-registered": "boolean",
"group-leaves": "integer",
"is-router-enabled": "boolean",
"las-get-address-count": "integer",
"subscriber-mode": "integer",
"total-active-groups": "integer",
"configuration-mcast-vrf-set": "boolean",
"querier-uptime": "integer",
"proxy-interface": "string",
"is-subscriber": "boolean",
"mte-vrf-id": "integer",
"state": "string",
"time-since-last-query-in-seconds": "integer",
"location": "integer",
"subscriber-id": "string",
"is-ip-enabled": "boolean",
"router-uptime-in-seconds": "integer",
"parent-ifhandle": "string",
"query-interval": "integer",
"configuration-mcast-vrf-error": "boolean",
"is-identity-present": "boolean",
"query-timeout": "integer",
"query-maximum-response-time": "integer",
"querier-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"igmp-version": "integer",
"las-ll-registration-count": "integer",
"is-interface-up": "boolean",
"mte-tuple-count": "integer",
"is-las-request": "boolean",
"prefix-length": "integer",
"las-null-update-count": "integer",
"is-querier": "boolean",
"robustness": "integer",
"las-unregistration-count": "integer",
"is-im-state-registered": "boolean",
"mtu": "integer",
"is-configurationverify": "boolean",
"time-since-last-report-in-seconds": "integer",
"configurationvrf-error": "boolean",
"host-version": "integer",
"group-joins": "integer"
}
ADDRESS - Retrieve
Retrieve operation of resource: address
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
QUERIER-ADDRESS - Retrieve
Retrieve operation of resource: querier-address
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SUBSCRIBER-ADDRESS - Retrieve
Retrieve operation of resource: subscriber-address
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
TRAFFIC-COUNTERS - Retrieve
Retrieve operation of resource: traffic-counters
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"checksum-errors": "integer",
"auxillary-data-length-errors": "integer",
"input-mtrace": "integer",
"socket-errors": "integer",
"packet-manager-input-errors": "integer",
"packets-out": "integer",
"input-no-idb": "integer",
"output-no-parent-interface-handle": "integer",
"receive-socket-errors": "integer",
"output-leaves": "integer",
"no-socket-connection": "integer",
"bad-scope-errors": "integer",
"input-leaves": "integer",
"invalid-source-address-errors": "integer",
"get-packet-failure": "integer",
"input-dvmrp": "integer",
"miscellaneous-errors": "integer",
"elapsed-time": "integer",
"input-no-platform-support-mtrace": "integer",
"input-queries": "integer",
"output-pim": "integer",
"input-disabled-idb": "integer",
"packet-manager-output-errors": "integer",
"format-errors": "integer",
"packets-in": "integer",
"input-no-vrf-mtrace": "integer",
"input-no-assigned-vrf-id": "integer",
"input-reports": "integer",
"input-pim": "integer",
"input-martian-address": "integer",
"output-queries": "integer",
"input-no-vrf-in-idb": "integer",
"output-mtrace": "integer",
"output-reports": "integer",
"output-dvmrp": "integer"
}
GROUPS - Retrieve
Retrieve operation of resource: groups
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"group": [
{
"uptime": "integer",
"older-host-version1-timer": "integer",
"row-status": "string",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-added": "boolean",
"older-host-version2-timer": "integer",
"last-reporter": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"expiration-time": "string",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-suppressed": "boolean",
"is-self-join": "boolean",
"is-low-memory": "boolean",
"interface-name-xr": "string",
"router-filter-mode": "integer",
"explicit-tracking-enabled": "boolean"
}
]
}
GROUP - Retrieve
Retrieve operation of resource: group
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"uptime": "integer",
"older-host-version1-timer": "integer",
"row-status": "string",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-added": "boolean",
"older-host-version2-timer": "integer",
"last-reporter": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"expiration-time": "string",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-suppressed": "boolean",
"is-self-join": "boolean",
"is-low-memory": "boolean",
"interface-name-xr": "string",
"router-filter-mode": "integer",
"explicit-tracking-enabled": "boolean"
}
GROUP-ADDRESS-XR - Retrieve
Retrieve operation of resource: group-address-xr
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
LAST-REPORTER - Retrieve
Retrieve operation of resource: last-reporter
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SOURCE-ADDRESS - Retrieve
Retrieve operation of resource: source-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
GROUP-SUMMARY - Retrieve
Retrieve operation of resource: group-summary
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"group-count": "integer",
"groutes": "integer",
"sg-routes": "integer",
"is-low-memory": "boolean"
}
IFRS-INTERFACE-SUMMARY - Retrieve
Retrieve operation of resource: ifrs-interface-summary
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-count": "integer",
"configuration-count": "integer"
}
GLOBAL-INTERFACE-TABLE - Retrieve
Retrieve operation of resource: global-interface-table
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface": [
{
"interface-name": "string",
"las-ll-remove-update-count": "integer",
"las-ll-add-update-count": "integer",
"las-update-count": "integer",
"configurationvrf-set": "boolean",
"vrf-id": "integer",
"subscriber-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"vrf-state": "integer",
"last-member-query-interval": "integer",
"interface-name-xr": "string",
"is-las-registered": "boolean",
"group-leaves": "integer",
"is-router-enabled": "boolean",
"las-get-address-count": "integer",
"subscriber-mode": "integer",
"total-active-groups": "integer",
"configuration-mcast-vrf-set": "boolean",
"querier-uptime": "integer",
"proxy-interface": "string",
"is-subscriber": "boolean",
"mte-vrf-id": "integer",
"state": "string",
"time-since-last-query-in-seconds": "integer",
"location": "integer",
"subscriber-id": "string",
"is-ip-enabled": "boolean",
"router-uptime-in-seconds": "integer",
"parent-ifhandle": "string",
"query-interval": "integer",
"configuration-mcast-vrf-error": "boolean",
"is-identity-present": "boolean",
"query-timeout": "integer",
"query-maximum-response-time": "integer",
"querier-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"igmp-version": "integer",
"las-ll-registration-count": "integer",
"is-interface-up": "boolean",
"mte-tuple-count": "integer",
"is-las-request": "boolean",
"prefix-length": "integer",
"las-null-update-count": "integer",
"is-querier": "boolean",
"robustness": "integer",
"las-unregistration-count": "integer",
"is-im-state-registered": "boolean",
"mtu": "integer",
"is-configurationverify": "boolean",
"time-since-last-report-in-seconds": "integer",
"configurationvrf-error": "boolean",
"host-version": "integer",
"group-joins": "integer"
}
]
}
INTERFACE - Retrieve
Retrieve operation of resource: interface
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"las-ll-remove-update-count": "integer",
"las-ll-add-update-count": "integer",
"las-update-count": "integer",
"configurationvrf-set": "boolean",
"vrf-id": "integer",
"subscriber-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"vrf-state": "integer",
"last-member-query-interval": "integer",
"interface-name-xr": "string",
"is-las-registered": "boolean",
"group-leaves": "integer",
"is-router-enabled": "boolean",
"las-get-address-count": "integer",
"subscriber-mode": "integer",
"total-active-groups": "integer",
"configuration-mcast-vrf-set": "boolean",
"querier-uptime": "integer",
"proxy-interface": "string",
"is-subscriber": "boolean",
"mte-vrf-id": "integer",
"state": "string",
"time-since-last-query-in-seconds": "integer",
"location": "integer",
"subscriber-id": "string",
"is-ip-enabled": "boolean",
"router-uptime-in-seconds": "integer",
"parent-ifhandle": "string",
"query-interval": "integer",
"configuration-mcast-vrf-error": "boolean",
"is-identity-present": "boolean",
"query-timeout": "integer",
"query-maximum-response-time": "integer",
"querier-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"igmp-version": "integer",
"las-ll-registration-count": "integer",
"is-interface-up": "boolean",
"mte-tuple-count": "integer",
"is-las-request": "boolean",
"prefix-length": "integer",
"las-null-update-count": "integer",
"is-querier": "boolean",
"robustness": "integer",
"las-unregistration-count": "integer",
"is-im-state-registered": "boolean",
"mtu": "integer",
"is-configurationverify": "boolean",
"time-since-last-report-in-seconds": "integer",
"configurationvrf-error": "boolean",
"host-version": "integer",
"group-joins": "integer"
}
ADDRESS - Retrieve
Retrieve operation of resource: address
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
QUERIER-ADDRESS - Retrieve
Retrieve operation of resource: querier-address
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SUBSCRIBER-ADDRESS - Retrieve
Retrieve operation of resource: subscriber-address
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SSM-MAP-DETAILS - Retrieve
Retrieve operation of resource: ssm-map-details
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ssm-map-detail": [
{
"response-pending": "boolean",
"query-interval": "integer",
"map-info": {
"source-counts": "integer",
"map-type": "integer",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
},
"expiration-time": "integer",
"sources": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"elapsed-time": "integer"
}
]
}
SSM-MAP-DETAIL - Retrieve
Retrieve operation of resource: ssm-map-detail
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"response-pending": "boolean",
"query-interval": "integer",
"map-info": {
"source-counts": "integer",
"map-type": "integer",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
},
"expiration-time": "integer",
"sources": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"elapsed-time": "integer"
}
MAP-INFO - Retrieve
Retrieve operation of resource: map-info
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"source-counts": "integer",
"map-type": "integer",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
GROUP-ADDRESS-XR - Retrieve
Retrieve operation of resource: group-address-xr
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SOURCES - Retrieve
Retrieve operation of resource: sources
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
INTERFACE-STATE-OFFS - Retrieve
Retrieve operation of resource: interface-state-offs
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-state-off": [
{
"las-ll-remove-update-count": "integer",
"las-ll-add-update-count": "integer",
"las-update-count": "integer",
"configurationvrf-set": "boolean",
"vrf-id": "integer",
"subscriber-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"vrf-state": "integer",
"last-member-query-interval": "integer",
"interface-name-xr": "string",
"is-las-registered": "boolean",
"group-leaves": "integer",
"is-router-enabled": "boolean",
"las-get-address-count": "integer",
"subscriber-mode": "integer",
"total-active-groups": "integer",
"configuration-mcast-vrf-set": "boolean",
"querier-uptime": "integer",
"proxy-interface": "string",
"is-subscriber": "boolean",
"mte-vrf-id": "integer",
"state": "string",
"time-since-last-query-in-seconds": "integer",
"location": "integer",
"subscriber-id": "string",
"is-ip-enabled": "boolean",
"router-uptime-in-seconds": "integer",
"parent-ifhandle": "string",
"query-interval": "integer",
"configuration-mcast-vrf-error": "boolean",
"is-identity-present": "boolean",
"query-timeout": "integer",
"query-maximum-response-time": "integer",
"querier-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"igmp-version": "integer",
"las-ll-registration-count": "integer",
"is-interface-up": "boolean",
"mte-tuple-count": "integer",
"is-las-request": "boolean",
"prefix-length": "integer",
"las-null-update-count": "integer",
"is-querier": "boolean",
"robustness": "integer",
"las-unregistration-count": "integer",
"is-im-state-registered": "boolean",
"mtu": "integer",
"is-configurationverify": "boolean",
"time-since-last-report-in-seconds": "integer",
"configurationvrf-error": "boolean",
"host-version": "integer",
"group-joins": "integer"
}
]
}
INTERFACE-STATE-OFF - Retrieve
Retrieve operation of resource: interface-state-off
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"las-ll-remove-update-count": "integer",
"las-ll-add-update-count": "integer",
"las-update-count": "integer",
"configurationvrf-set": "boolean",
"vrf-id": "integer",
"subscriber-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"vrf-state": "integer",
"last-member-query-interval": "integer",
"interface-name-xr": "string",
"is-las-registered": "boolean",
"group-leaves": "integer",
"is-router-enabled": "boolean",
"las-get-address-count": "integer",
"subscriber-mode": "integer",
"total-active-groups": "integer",
"configuration-mcast-vrf-set": "boolean",
"querier-uptime": "integer",
"proxy-interface": "string",
"is-subscriber": "boolean",
"mte-vrf-id": "integer",
"state": "string",
"time-since-last-query-in-seconds": "integer",
"location": "integer",
"subscriber-id": "string",
"is-ip-enabled": "boolean",
"router-uptime-in-seconds": "integer",
"parent-ifhandle": "string",
"query-interval": "integer",
"configuration-mcast-vrf-error": "boolean",
"is-identity-present": "boolean",
"query-timeout": "integer",
"query-maximum-response-time": "integer",
"querier-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"igmp-version": "integer",
"las-ll-registration-count": "integer",
"is-interface-up": "boolean",
"mte-tuple-count": "integer",
"is-las-request": "boolean",
"prefix-length": "integer",
"las-null-update-count": "integer",
"is-querier": "boolean",
"robustness": "integer",
"las-unregistration-count": "integer",
"is-im-state-registered": "boolean",
"mtu": "integer",
"is-configurationverify": "boolean",
"time-since-last-report-in-seconds": "integer",
"configurationvrf-error": "boolean",
"host-version": "integer",
"group-joins": "integer"
}
ADDRESS - Retrieve
Retrieve operation of resource: address
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
QUERIER-ADDRESS - Retrieve
Retrieve operation of resource: querier-address
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SUBSCRIBER-ADDRESS - Retrieve
Retrieve operation of resource: subscriber-address
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
ACTIVE - Retrieve
Retrieve operation of resource: active
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"default-context": {
"interface-state-offs": {
"interface-state-off": [
{
"interface-name": "string",
"las-ll-remove-update-count": "integer",
"las-ll-add-update-count": "integer",
"las-update-count": "integer",
"configurationvrf-set": "boolean",
"vrf-id": "integer",
"subscriber-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"vrf-state": "integer",
"last-member-query-interval": "integer",
"interface-name-xr": "string",
"is-las-registered": "boolean",
"group-leaves": "integer",
"is-router-enabled": "boolean",
"las-get-address-count": "integer",
"subscriber-mode": "integer",
"total-active-groups": "integer",
"configuration-mcast-vrf-set": "boolean",
"querier-uptime": "integer",
"proxy-interface": "string",
"is-subscriber": "boolean",
"mte-vrf-id": "integer",
"state": "string",
"time-since-last-query-in-seconds": "integer",
"location": "integer",
"subscriber-id": "string",
"is-ip-enabled": "boolean",
"router-uptime-in-seconds": "integer",
"parent-ifhandle": "string",
"query-interval": "integer",
"configuration-mcast-vrf-error": "boolean",
"is-identity-present": "boolean",
"query-timeout": "integer",
"query-maximum-response-time": "integer",
"querier-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"igmp-version": "integer",
"las-ll-registration-count": "integer",
"is-interface-up": "boolean",
"mte-tuple-count": "integer",
"is-las-request": "boolean",
"prefix-length": "integer",
"las-null-update-count": "integer",
"is-querier": "boolean",
"robustness": "integer",
"las-unregistration-count": "integer",
"is-im-state-registered": "boolean",
"mtu": "integer",
"is-configurationverify": "boolean",
"time-since-last-report-in-seconds": "integer",
"configurationvrf-error": "boolean",
"host-version": "integer",
"group-joins": "integer"
}
]
}
}
}
VRFS - Retrieve
Retrieve operation of resource: vrfs
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"vrf": [
{
"interface-state-offs": {
"interface-state-off": [
{
"interface-name": "string",
"las-ll-remove-update-count": "integer",
"las-ll-add-update-count": "integer",
"las-update-count": "integer",
"configurationvrf-set": "boolean",
"vrf-id": "integer",
"subscriber-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"vrf-state": "integer",
"last-member-query-interval": "integer",
"interface-name-xr": "string",
"is-las-registered": "boolean",
"group-leaves": "integer",
"is-router-enabled": "boolean",
"las-get-address-count": "integer",
"subscriber-mode": "integer",
"total-active-groups": "integer",
"configuration-mcast-vrf-set": "boolean",
"querier-uptime": "integer",
"proxy-interface": "string",
"is-subscriber": "boolean",
"mte-vrf-id": "integer",
"state": "string",
"time-since-last-query-in-seconds": "integer",
"location": "integer",
"subscriber-id": "string",
"is-ip-enabled": "boolean",
"router-uptime-in-seconds": "integer",
"parent-ifhandle": "string",
"query-interval": "integer",
"configuration-mcast-vrf-error": "boolean",
"is-identity-present": "boolean",
"query-timeout": "integer",
"query-maximum-response-time": "integer",
"querier-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"igmp-version": "integer",
"las-ll-registration-count": "integer",
"is-interface-up": "boolean",
"mte-tuple-count": "integer",
"is-las-request": "boolean",
"prefix-length": "integer",
"las-null-update-count": "integer",
"is-querier": "boolean",
"robustness": "integer",
"las-unregistration-count": "integer",
"is-im-state-registered": "boolean",
"mtu": "integer",
"is-configurationverify": "boolean",
"time-since-last-report-in-seconds": "integer",
"configurationvrf-error": "boolean",
"host-version": "integer",
"group-joins": "integer"
}
]
}
}
]
}
VRF - Retrieve
Retrieve operation of resource: vrf
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-state-offs": {
"interface-state-off": [
{
"interface-name": "string",
"las-ll-remove-update-count": "integer",
"las-ll-add-update-count": "integer",
"las-update-count": "integer",
"configurationvrf-set": "boolean",
"vrf-id": "integer",
"subscriber-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"vrf-state": "integer",
"last-member-query-interval": "integer",
"interface-name-xr": "string",
"is-las-registered": "boolean",
"group-leaves": "integer",
"is-router-enabled": "boolean",
"las-get-address-count": "integer",
"subscriber-mode": "integer",
"total-active-groups": "integer",
"configuration-mcast-vrf-set": "boolean",
"querier-uptime": "integer",
"proxy-interface": "string",
"is-subscriber": "boolean",
"mte-vrf-id": "integer",
"state": "string",
"time-since-last-query-in-seconds": "integer",
"location": "integer",
"subscriber-id": "string",
"is-ip-enabled": "boolean",
"router-uptime-in-seconds": "integer",
"parent-ifhandle": "string",
"query-interval": "integer",
"configuration-mcast-vrf-error": "boolean",
"is-identity-present": "boolean",
"query-timeout": "integer",
"query-maximum-response-time": "integer",
"querier-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"igmp-version": "integer",
"las-ll-registration-count": "integer",
"is-interface-up": "boolean",
"mte-tuple-count": "integer",
"is-las-request": "boolean",
"prefix-length": "integer",
"las-null-update-count": "integer",
"is-querier": "boolean",
"robustness": "integer",
"las-unregistration-count": "integer",
"is-im-state-registered": "boolean",
"mtu": "integer",
"is-configurationverify": "boolean",
"time-since-last-report-in-seconds": "integer",
"configurationvrf-error": "boolean",
"host-version": "integer",
"group-joins": "integer"
}
]
}
}
SUMMARY - Retrieve
Retrieve operation of resource: summary
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"group-count": "integer",
"disabled-interface-count": "integer",
"group-limit": "integer",
"supported-interfaces": "integer",
"robustness": "integer",
"is-disabled": "boolean",
"enabled-interface-count": "integer",
"node-low-memory": "boolean",
"unsupported-interfaces": "integer",
"tunnel-mte-config-count": "integer",
"interface": [
{
"group-count": "integer",
"parent-ifhandle": "string",
"router-uptime-in-seconds": "integer",
"interface-name": "string",
"group-limit": "integer",
"on-off": "boolean",
"time-since-last-report-in-seconds": "integer",
"time-since-last-query-in-seconds": "integer"
}
]
}
INTERFACE - Retrieve
Retrieve operation of resource: interface
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"group-count": "integer",
"parent-ifhandle": "string",
"router-uptime-in-seconds": "integer",
"interface-name": "string",
"group-limit": "integer",
"on-off": "boolean",
"time-since-last-report-in-seconds": "integer",
"time-since-last-query-in-seconds": "integer"
}
INTERFACE-STATE-ONS - Retrieve
Retrieve operation of resource: interface-state-ons
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-state-on": [
{
"las-ll-remove-update-count": "integer",
"las-ll-add-update-count": "integer",
"las-update-count": "integer",
"configurationvrf-set": "boolean",
"vrf-id": "integer",
"subscriber-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"vrf-state": "integer",
"last-member-query-interval": "integer",
"interface-name-xr": "string",
"is-las-registered": "boolean",
"group-leaves": "integer",
"is-router-enabled": "boolean",
"las-get-address-count": "integer",
"subscriber-mode": "integer",
"total-active-groups": "integer",
"configuration-mcast-vrf-set": "boolean",
"querier-uptime": "integer",
"proxy-interface": "string",
"is-subscriber": "boolean",
"mte-vrf-id": "integer",
"state": "string",
"time-since-last-query-in-seconds": "integer",
"location": "integer",
"subscriber-id": "string",
"is-ip-enabled": "boolean",
"router-uptime-in-seconds": "integer",
"parent-ifhandle": "string",
"query-interval": "integer",
"configuration-mcast-vrf-error": "boolean",
"is-identity-present": "boolean",
"query-timeout": "integer",
"query-maximum-response-time": "integer",
"querier-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"igmp-version": "integer",
"las-ll-registration-count": "integer",
"is-interface-up": "boolean",
"mte-tuple-count": "integer",
"is-las-request": "boolean",
"prefix-length": "integer",
"las-null-update-count": "integer",
"is-querier": "boolean",
"robustness": "integer",
"las-unregistration-count": "integer",
"is-im-state-registered": "boolean",
"mtu": "integer",
"is-configurationverify": "boolean",
"time-since-last-report-in-seconds": "integer",
"configurationvrf-error": "boolean",
"host-version": "integer",
"group-joins": "integer"
}
]
}
INTERFACE-STATE-ON - Retrieve
Retrieve operation of resource: interface-state-on
vrf-name
in path
string
ID of vrf-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"las-ll-remove-update-count": "integer",
"las-ll-add-update-count": "integer",
"las-update-count": "integer",
"configurationvrf-set": "boolean",
"vrf-id": "integer",
"subscriber-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"vrf-state": "integer",
"last-member-query-interval": "integer",
"interface-name-xr": "string",
"is-las-registered": "boolean",
"group-leaves": "integer",
"is-router-enabled": "boolean",
"las-get-address-count": "integer",
"subscriber-mode": "integer",
"total-active-groups": "integer",
"configuration-mcast-vrf-set": "boolean",
"querier-uptime": "integer",
"proxy-interface": "string",
"is-subscriber": "boolean",
"mte-vrf-id": "integer",
"state": "string",
"time-since-last-query-in-seconds": "integer",
"location": "integer",
"subscriber-id": "string",
"is-ip-enabled": "boolean",
"router-uptime-in-seconds": "integer",
"parent-ifhandle": "string",
"query-interval": "integer",
"configuration-mcast-vrf-error": "boolean",
"is-identity-present": "boolean",
"query-timeout": "integer",
"query-maximum-response-time": "integer",
"querier-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"igmp-version": "integer",
"las-ll-registration-count": "integer",
"is-interface-up": "boolean",
"mte-tuple-count": "integer",
"is-las-request": "boolean",
"prefix-length": "integer",
"las-null-update-count": "integer",
"is-querier": "boolean",
"robustness": "integer",
"las-unregistration-count": "integer",
"is-im-state-registered": "boolean",
"mtu": "integer",
"is-configurationverify": "boolean",
"time-since-last-report-in-seconds": "integer",
"configurationvrf-error": "boolean",
"host-version": "integer",
"group-joins": "integer"
}
ADDRESS - Retrieve
Retrieve operation of resource: address
vrf-name
in path
string
ID of vrf-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
QUERIER-ADDRESS - Retrieve
Retrieve operation of resource: querier-address
vrf-name
in path
string
ID of vrf-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SUBSCRIBER-ADDRESS - Retrieve
Retrieve operation of resource: subscriber-address
vrf-name
in path
string
ID of vrf-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
DETAIL-GROUPS - Retrieve
Retrieve operation of resource: detail-groups
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"detail-group": [
{
"source": [
{
"uptime": "integer",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"expiration-time": "string",
"is-local": "boolean",
"is-forward": "boolean",
"is-added": "boolean",
"flags": "string",
"is-remote": "boolean",
"is-we-report": "boolean"
}
],
"is-router-exclude-mode": "boolean",
"group-info": {
"uptime": "integer",
"older-host-version1-timer": "integer",
"row-status": "string",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-added": "boolean",
"older-host-version2-timer": "integer",
"last-reporter": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"expiration-time": "string",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-suppressed": "boolean",
"is-self-join": "boolean",
"is-low-memory": "boolean",
"interface-name-xr": "string",
"router-filter-mode": "integer",
"explicit-tracking-enabled": "boolean"
},
"is-host-exclude-mode": "boolean"
}
]
}
DETAIL-GROUP - Retrieve
Retrieve operation of resource: detail-group
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"source": [
{
"uptime": "integer",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"expiration-time": "string",
"is-local": "boolean",
"is-forward": "boolean",
"is-added": "boolean",
"flags": "string",
"is-remote": "boolean",
"is-we-report": "boolean"
}
],
"is-router-exclude-mode": "boolean",
"group-info": {
"uptime": "integer",
"older-host-version1-timer": "integer",
"row-status": "string",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-added": "boolean",
"older-host-version2-timer": "integer",
"last-reporter": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"expiration-time": "string",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-suppressed": "boolean",
"is-self-join": "boolean",
"is-low-memory": "boolean",
"interface-name-xr": "string",
"router-filter-mode": "integer",
"explicit-tracking-enabled": "boolean"
},
"is-host-exclude-mode": "boolean"
}
GROUP-INFO - Retrieve
Retrieve operation of resource: group-info
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"uptime": "integer",
"older-host-version1-timer": "integer",
"row-status": "string",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-added": "boolean",
"older-host-version2-timer": "integer",
"last-reporter": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"expiration-time": "string",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-suppressed": "boolean",
"is-self-join": "boolean",
"is-low-memory": "boolean",
"interface-name-xr": "string",
"router-filter-mode": "integer",
"explicit-tracking-enabled": "boolean"
}
GROUP-ADDRESS-XR - Retrieve
Retrieve operation of resource: group-address-xr
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
LAST-REPORTER - Retrieve
Retrieve operation of resource: last-reporter
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SOURCE-ADDRESS - Retrieve
Retrieve operation of resource: source-address
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SOURCE - Retrieve
Retrieve operation of resource: source
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"uptime": "integer",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"expiration-time": "string",
"is-local": "boolean",
"is-forward": "boolean",
"is-added": "boolean",
"flags": "string",
"is-remote": "boolean",
"is-we-report": "boolean"
}
SOURCE-ADDRESS - Retrieve
Retrieve operation of resource: source-address
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
NON-ACTIVE-GROUPS - Retrieve
Retrieve operation of resource: non-active-groups
vrf-name
in path
string
ID of vrf-name
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"non-active-groups": [
{
"interface": "string",
"group-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"reason-for-non-activity": "string",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
}
NON-ACTIVE-GROUPS - Retrieve
Retrieve operation of resource: non-active-groups
vrf-name
in path
string
ID of vrf-name
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface": "string",
"group-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"reason-for-non-activity": "string",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
GROUP-ADDRESS - Retrieve
Retrieve operation of resource: group-address
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SOURCE-ADDRESS - Retrieve
Retrieve operation of resource: source-address
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SSM-MAPS - Retrieve
Retrieve operation of resource: ssm-maps
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ssm-map": [
{
"source-counts": "integer",
"map-type": "integer",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
}
SSM-MAP - Retrieve
Retrieve operation of resource: ssm-map
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"source-counts": "integer",
"map-type": "integer",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
GROUP-ADDRESS-XR - Retrieve
Retrieve operation of resource: group-address-xr
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
EXPLICIT-GROUPS - Retrieve
Retrieve operation of resource: explicit-groups
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"explicit-group": [
{
"exclude-hosts": "integer",
"host": [
{
"uptime": "integer",
"source-address": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"is-exclude": "boolean",
"expiration-time": "integer",
"source-count": "integer",
"address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
],
"include-hosts": "integer",
"group-info": {
"uptime": "integer",
"older-host-version1-timer": "integer",
"row-status": "string",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-added": "boolean",
"older-host-version2-timer": "integer",
"last-reporter": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"expiration-time": "string",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-suppressed": "boolean",
"is-self-join": "boolean",
"is-low-memory": "boolean",
"interface-name-xr": "string",
"router-filter-mode": "integer",
"explicit-tracking-enabled": "boolean"
}
}
]
}
EXPLICIT-GROUP - Retrieve
Retrieve operation of resource: explicit-group
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"exclude-hosts": "integer",
"host": [
{
"uptime": "integer",
"source-address": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"is-exclude": "boolean",
"expiration-time": "integer",
"source-count": "integer",
"address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
],
"include-hosts": "integer",
"group-info": {
"uptime": "integer",
"older-host-version1-timer": "integer",
"row-status": "string",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-added": "boolean",
"older-host-version2-timer": "integer",
"last-reporter": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"expiration-time": "string",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-suppressed": "boolean",
"is-self-join": "boolean",
"is-low-memory": "boolean",
"interface-name-xr": "string",
"router-filter-mode": "integer",
"explicit-tracking-enabled": "boolean"
}
}
GROUP-INFO - Retrieve
Retrieve operation of resource: group-info
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"uptime": "integer",
"older-host-version1-timer": "integer",
"row-status": "string",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-added": "boolean",
"older-host-version2-timer": "integer",
"last-reporter": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"expiration-time": "string",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-suppressed": "boolean",
"is-self-join": "boolean",
"is-low-memory": "boolean",
"interface-name-xr": "string",
"router-filter-mode": "integer",
"explicit-tracking-enabled": "boolean"
}
GROUP-ADDRESS-XR - Retrieve
Retrieve operation of resource: group-address-xr
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
LAST-REPORTER - Retrieve
Retrieve operation of resource: last-reporter
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SOURCE-ADDRESS - Retrieve
Retrieve operation of resource: source-address
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
HOST - Retrieve
Retrieve operation of resource: host
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"uptime": "integer",
"source-address": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"is-exclude": "boolean",
"expiration-time": "integer",
"source-count": "integer",
"address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
ADDRESS - Retrieve
Retrieve operation of resource: address
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SOURCE-ADDRESS - Retrieve
Retrieve operation of resource: source-address
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
INTERFACE-TABLE - Retrieve
Retrieve operation of resource: interface-table
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface": [
{
"interface-name": "string",
"las-ll-remove-update-count": "integer",
"las-ll-add-update-count": "integer",
"las-update-count": "integer",
"configurationvrf-set": "boolean",
"vrf-id": "integer",
"subscriber-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"vrf-state": "integer",
"last-member-query-interval": "integer",
"interface-name-xr": "string",
"is-las-registered": "boolean",
"group-leaves": "integer",
"is-router-enabled": "boolean",
"las-get-address-count": "integer",
"subscriber-mode": "integer",
"total-active-groups": "integer",
"configuration-mcast-vrf-set": "boolean",
"querier-uptime": "integer",
"proxy-interface": "string",
"is-subscriber": "boolean",
"mte-vrf-id": "integer",
"state": "string",
"time-since-last-query-in-seconds": "integer",
"location": "integer",
"subscriber-id": "string",
"is-ip-enabled": "boolean",
"router-uptime-in-seconds": "integer",
"parent-ifhandle": "string",
"query-interval": "integer",
"configuration-mcast-vrf-error": "boolean",
"is-identity-present": "boolean",
"query-timeout": "integer",
"query-maximum-response-time": "integer",
"querier-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"igmp-version": "integer",
"las-ll-registration-count": "integer",
"is-interface-up": "boolean",
"mte-tuple-count": "integer",
"is-las-request": "boolean",
"prefix-length": "integer",
"las-null-update-count": "integer",
"is-querier": "boolean",
"robustness": "integer",
"las-unregistration-count": "integer",
"is-im-state-registered": "boolean",
"mtu": "integer",
"is-configurationverify": "boolean",
"time-since-last-report-in-seconds": "integer",
"configurationvrf-error": "boolean",
"host-version": "integer",
"group-joins": "integer"
}
]
}
INTERFACE - Retrieve
Retrieve operation of resource: interface
vrf-name
in path
string
ID of vrf-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"las-ll-remove-update-count": "integer",
"las-ll-add-update-count": "integer",
"las-update-count": "integer",
"configurationvrf-set": "boolean",
"vrf-id": "integer",
"subscriber-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"vrf-state": "integer",
"last-member-query-interval": "integer",
"interface-name-xr": "string",
"is-las-registered": "boolean",
"group-leaves": "integer",
"is-router-enabled": "boolean",
"las-get-address-count": "integer",
"subscriber-mode": "integer",
"total-active-groups": "integer",
"configuration-mcast-vrf-set": "boolean",
"querier-uptime": "integer",
"proxy-interface": "string",
"is-subscriber": "boolean",
"mte-vrf-id": "integer",
"state": "string",
"time-since-last-query-in-seconds": "integer",
"location": "integer",
"subscriber-id": "string",
"is-ip-enabled": "boolean",
"router-uptime-in-seconds": "integer",
"parent-ifhandle": "string",
"query-interval": "integer",
"configuration-mcast-vrf-error": "boolean",
"is-identity-present": "boolean",
"query-timeout": "integer",
"query-maximum-response-time": "integer",
"querier-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"igmp-version": "integer",
"las-ll-registration-count": "integer",
"is-interface-up": "boolean",
"mte-tuple-count": "integer",
"is-las-request": "boolean",
"prefix-length": "integer",
"las-null-update-count": "integer",
"is-querier": "boolean",
"robustness": "integer",
"las-unregistration-count": "integer",
"is-im-state-registered": "boolean",
"mtu": "integer",
"is-configurationverify": "boolean",
"time-since-last-report-in-seconds": "integer",
"configurationvrf-error": "boolean",
"host-version": "integer",
"group-joins": "integer"
}
ADDRESS - Retrieve
Retrieve operation of resource: address
vrf-name
in path
string
ID of vrf-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
QUERIER-ADDRESS - Retrieve
Retrieve operation of resource: querier-address
vrf-name
in path
string
ID of vrf-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SUBSCRIBER-ADDRESS - Retrieve
Retrieve operation of resource: subscriber-address
vrf-name
in path
string
ID of vrf-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
INTERFACE-UNICAST-QOS-ADJUSTS - Retrieve
Retrieve operation of resource: interface-unicast-qos-adjusts
vrf-name
in path
string
ID of vrf-name
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-unicast-qos-adjust": [
{
"is-virtual-access": "boolean",
"rate": "integer",
"rate-increments": "integer",
"rate-decrements": "integer",
"update": [
{
"is-add": "boolean",
"group-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"received-time": "integer",
"weight": "integer",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
}
]
}
INTERFACE-UNICAST-QOS-ADJUST - Retrieve
Retrieve operation of resource: interface-unicast-qos-adjust
vrf-name
in path
string
ID of vrf-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-virtual-access": "boolean",
"rate": "integer",
"rate-increments": "integer",
"rate-decrements": "integer",
"update": [
{
"is-add": "boolean",
"group-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"received-time": "integer",
"weight": "integer",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
}
UPDATE - Retrieve
Retrieve operation of resource: update
vrf-name
in path
string
ID of vrf-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-add": "boolean",
"group-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"received-time": "integer",
"weight": "integer",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
SOURCE-ADDRESS - Retrieve
Retrieve operation of resource: source-address
vrf-name
in path
string
ID of vrf-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
GROUP-ADDRESS - Retrieve
Retrieve operation of resource: group-address
vrf-name
in path
string
ID of vrf-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
RANGES - Retrieve
Retrieve operation of resource: ranges
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"range": [
{
"is-stale": "boolean",
"protocol": "string",
"prefix-length": "integer",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
}
RANGE - Retrieve
Retrieve operation of resource: range
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-stale": "boolean",
"protocol": "string",
"prefix-length": "integer",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
GROUP-ADDRESS-XR - Retrieve
Retrieve operation of resource: group-address-xr
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
IFRS-INTERFACES - Retrieve
Retrieve operation of resource: ifrs-interfaces
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ifrs-interface": [
{
"join-group-count": "integer",
"igmp-interface-entry": {
"las-ll-remove-update-count": "integer",
"las-ll-add-update-count": "integer",
"las-update-count": "integer",
"configurationvrf-set": "boolean",
"vrf-id": "integer",
"subscriber-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"vrf-state": "integer",
"last-member-query-interval": "integer",
"interface-name-xr": "string",
"is-las-registered": "boolean",
"group-leaves": "integer",
"is-router-enabled": "boolean",
"las-get-address-count": "integer",
"subscriber-mode": "integer",
"total-active-groups": "integer",
"configuration-mcast-vrf-set": "boolean",
"querier-uptime": "integer",
"proxy-interface": "string",
"is-subscriber": "boolean",
"mte-vrf-id": "integer",
"state": "string",
"time-since-last-query-in-seconds": "integer",
"location": "integer",
"subscriber-id": "string",
"is-ip-enabled": "boolean",
"router-uptime-in-seconds": "integer",
"parent-ifhandle": "string",
"query-interval": "integer",
"configuration-mcast-vrf-error": "boolean",
"is-identity-present": "boolean",
"query-timeout": "integer",
"query-maximum-response-time": "integer",
"querier-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"igmp-version": "integer",
"las-ll-registration-count": "integer",
"is-interface-up": "boolean",
"mte-tuple-count": "integer",
"is-las-request": "boolean",
"prefix-length": "integer",
"las-null-update-count": "integer",
"is-querier": "boolean",
"robustness": "integer",
"las-unregistration-count": "integer",
"is-im-state-registered": "boolean",
"mtu": "integer",
"is-configurationverify": "boolean",
"time-since-last-report-in-seconds": "integer",
"configurationvrf-error": "boolean",
"host-version": "integer",
"group-joins": "integer"
}
}
]
}
IFRS-INTERFACE - Retrieve
Retrieve operation of resource: ifrs-interface
vrf-name
in path
string
ID of vrf-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"join-group-count": "integer",
"igmp-interface-entry": {
"las-ll-remove-update-count": "integer",
"las-ll-add-update-count": "integer",
"las-update-count": "integer",
"configurationvrf-set": "boolean",
"vrf-id": "integer",
"subscriber-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"vrf-state": "integer",
"last-member-query-interval": "integer",
"interface-name-xr": "string",
"is-las-registered": "boolean",
"group-leaves": "integer",
"is-router-enabled": "boolean",
"las-get-address-count": "integer",
"subscriber-mode": "integer",
"total-active-groups": "integer",
"configuration-mcast-vrf-set": "boolean",
"querier-uptime": "integer",
"proxy-interface": "string",
"is-subscriber": "boolean",
"mte-vrf-id": "integer",
"state": "string",
"time-since-last-query-in-seconds": "integer",
"location": "integer",
"subscriber-id": "string",
"is-ip-enabled": "boolean",
"router-uptime-in-seconds": "integer",
"parent-ifhandle": "string",
"query-interval": "integer",
"configuration-mcast-vrf-error": "boolean",
"is-identity-present": "boolean",
"query-timeout": "integer",
"query-maximum-response-time": "integer",
"querier-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"igmp-version": "integer",
"las-ll-registration-count": "integer",
"is-interface-up": "boolean",
"mte-tuple-count": "integer",
"is-las-request": "boolean",
"prefix-length": "integer",
"las-null-update-count": "integer",
"is-querier": "boolean",
"robustness": "integer",
"las-unregistration-count": "integer",
"is-im-state-registered": "boolean",
"mtu": "integer",
"is-configurationverify": "boolean",
"time-since-last-report-in-seconds": "integer",
"configurationvrf-error": "boolean",
"host-version": "integer",
"group-joins": "integer"
}
}
IGMP-INTERFACE-ENTRY - Retrieve
Retrieve operation of resource: igmp-interface-entry
vrf-name
in path
string
ID of vrf-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"las-ll-remove-update-count": "integer",
"las-ll-add-update-count": "integer",
"las-update-count": "integer",
"configurationvrf-set": "boolean",
"vrf-id": "integer",
"subscriber-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"vrf-state": "integer",
"last-member-query-interval": "integer",
"interface-name-xr": "string",
"is-las-registered": "boolean",
"group-leaves": "integer",
"is-router-enabled": "boolean",
"las-get-address-count": "integer",
"subscriber-mode": "integer",
"total-active-groups": "integer",
"configuration-mcast-vrf-set": "boolean",
"querier-uptime": "integer",
"proxy-interface": "string",
"is-subscriber": "boolean",
"mte-vrf-id": "integer",
"state": "string",
"time-since-last-query-in-seconds": "integer",
"location": "integer",
"subscriber-id": "string",
"is-ip-enabled": "boolean",
"router-uptime-in-seconds": "integer",
"parent-ifhandle": "string",
"query-interval": "integer",
"configuration-mcast-vrf-error": "boolean",
"is-identity-present": "boolean",
"query-timeout": "integer",
"query-maximum-response-time": "integer",
"querier-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"igmp-version": "integer",
"las-ll-registration-count": "integer",
"is-interface-up": "boolean",
"mte-tuple-count": "integer",
"is-las-request": "boolean",
"prefix-length": "integer",
"las-null-update-count": "integer",
"is-querier": "boolean",
"robustness": "integer",
"las-unregistration-count": "integer",
"is-im-state-registered": "boolean",
"mtu": "integer",
"is-configurationverify": "boolean",
"time-since-last-report-in-seconds": "integer",
"configurationvrf-error": "boolean",
"host-version": "integer",
"group-joins": "integer"
}
ADDRESS - Retrieve
Retrieve operation of resource: address
vrf-name
in path
string
ID of vrf-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
QUERIER-ADDRESS - Retrieve
Retrieve operation of resource: querier-address
vrf-name
in path
string
ID of vrf-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SUBSCRIBER-ADDRESS - Retrieve
Retrieve operation of resource: subscriber-address
vrf-name
in path
string
ID of vrf-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
TRAFFIC-COUNTERS - Retrieve
Retrieve operation of resource: traffic-counters
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"checksum-errors": "integer",
"auxillary-data-length-errors": "integer",
"input-mtrace": "integer",
"socket-errors": "integer",
"packet-manager-input-errors": "integer",
"packets-out": "integer",
"input-no-idb": "integer",
"output-no-parent-interface-handle": "integer",
"receive-socket-errors": "integer",
"output-leaves": "integer",
"no-socket-connection": "integer",
"bad-scope-errors": "integer",
"input-leaves": "integer",
"invalid-source-address-errors": "integer",
"get-packet-failure": "integer",
"input-dvmrp": "integer",
"miscellaneous-errors": "integer",
"elapsed-time": "integer",
"input-no-platform-support-mtrace": "integer",
"input-queries": "integer",
"output-pim": "integer",
"input-disabled-idb": "integer",
"packet-manager-output-errors": "integer",
"format-errors": "integer",
"packets-in": "integer",
"input-no-vrf-mtrace": "integer",
"input-no-assigned-vrf-id": "integer",
"input-reports": "integer",
"input-pim": "integer",
"input-martian-address": "integer",
"output-queries": "integer",
"input-no-vrf-in-idb": "integer",
"output-mtrace": "integer",
"output-reports": "integer",
"output-dvmrp": "integer"
}
GROUPS - Retrieve
Retrieve operation of resource: groups
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"group": [
{
"uptime": "integer",
"older-host-version1-timer": "integer",
"row-status": "string",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-added": "boolean",
"older-host-version2-timer": "integer",
"last-reporter": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"expiration-time": "string",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-suppressed": "boolean",
"is-self-join": "boolean",
"is-low-memory": "boolean",
"interface-name-xr": "string",
"router-filter-mode": "integer",
"explicit-tracking-enabled": "boolean"
}
]
}
GROUP - Retrieve
Retrieve operation of resource: group
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"uptime": "integer",
"older-host-version1-timer": "integer",
"row-status": "string",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-added": "boolean",
"older-host-version2-timer": "integer",
"last-reporter": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"expiration-time": "string",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-suppressed": "boolean",
"is-self-join": "boolean",
"is-low-memory": "boolean",
"interface-name-xr": "string",
"router-filter-mode": "integer",
"explicit-tracking-enabled": "boolean"
}
GROUP-ADDRESS-XR - Retrieve
Retrieve operation of resource: group-address-xr
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
LAST-REPORTER - Retrieve
Retrieve operation of resource: last-reporter
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SOURCE-ADDRESS - Retrieve
Retrieve operation of resource: source-address
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
GROUP-SUMMARY - Retrieve
Retrieve operation of resource: group-summary
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"group-count": "integer",
"groutes": "integer",
"sg-routes": "integer",
"is-low-memory": "boolean"
}
IFRS-INTERFACE-SUMMARY - Retrieve
Retrieve operation of resource: ifrs-interface-summary
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-count": "integer",
"configuration-count": "integer"
}
GLOBAL-INTERFACE-TABLE - Retrieve
Retrieve operation of resource: global-interface-table
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface": [
{
"interface-name": "string",
"las-ll-remove-update-count": "integer",
"las-ll-add-update-count": "integer",
"las-update-count": "integer",
"configurationvrf-set": "boolean",
"vrf-id": "integer",
"subscriber-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"vrf-state": "integer",
"last-member-query-interval": "integer",
"interface-name-xr": "string",
"is-las-registered": "boolean",
"group-leaves": "integer",
"is-router-enabled": "boolean",
"las-get-address-count": "integer",
"subscriber-mode": "integer",
"total-active-groups": "integer",
"configuration-mcast-vrf-set": "boolean",
"querier-uptime": "integer",
"proxy-interface": "string",
"is-subscriber": "boolean",
"mte-vrf-id": "integer",
"state": "string",
"time-since-last-query-in-seconds": "integer",
"location": "integer",
"subscriber-id": "string",
"is-ip-enabled": "boolean",
"router-uptime-in-seconds": "integer",
"parent-ifhandle": "string",
"query-interval": "integer",
"configuration-mcast-vrf-error": "boolean",
"is-identity-present": "boolean",
"query-timeout": "integer",
"query-maximum-response-time": "integer",
"querier-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"igmp-version": "integer",
"las-ll-registration-count": "integer",
"is-interface-up": "boolean",
"mte-tuple-count": "integer",
"is-las-request": "boolean",
"prefix-length": "integer",
"las-null-update-count": "integer",
"is-querier": "boolean",
"robustness": "integer",
"las-unregistration-count": "integer",
"is-im-state-registered": "boolean",
"mtu": "integer",
"is-configurationverify": "boolean",
"time-since-last-report-in-seconds": "integer",
"configurationvrf-error": "boolean",
"host-version": "integer",
"group-joins": "integer"
}
]
}
INTERFACE - Retrieve
Retrieve operation of resource: interface
vrf-name
in path
string
ID of vrf-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"las-ll-remove-update-count": "integer",
"las-ll-add-update-count": "integer",
"las-update-count": "integer",
"configurationvrf-set": "boolean",
"vrf-id": "integer",
"subscriber-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"vrf-state": "integer",
"last-member-query-interval": "integer",
"interface-name-xr": "string",
"is-las-registered": "boolean",
"group-leaves": "integer",
"is-router-enabled": "boolean",
"las-get-address-count": "integer",
"subscriber-mode": "integer",
"total-active-groups": "integer",
"configuration-mcast-vrf-set": "boolean",
"querier-uptime": "integer",
"proxy-interface": "string",
"is-subscriber": "boolean",
"mte-vrf-id": "integer",
"state": "string",
"time-since-last-query-in-seconds": "integer",
"location": "integer",
"subscriber-id": "string",
"is-ip-enabled": "boolean",
"router-uptime-in-seconds": "integer",
"parent-ifhandle": "string",
"query-interval": "integer",
"configuration-mcast-vrf-error": "boolean",
"is-identity-present": "boolean",
"query-timeout": "integer",
"query-maximum-response-time": "integer",
"querier-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"igmp-version": "integer",
"las-ll-registration-count": "integer",
"is-interface-up": "boolean",
"mte-tuple-count": "integer",
"is-las-request": "boolean",
"prefix-length": "integer",
"las-null-update-count": "integer",
"is-querier": "boolean",
"robustness": "integer",
"las-unregistration-count": "integer",
"is-im-state-registered": "boolean",
"mtu": "integer",
"is-configurationverify": "boolean",
"time-since-last-report-in-seconds": "integer",
"configurationvrf-error": "boolean",
"host-version": "integer",
"group-joins": "integer"
}
ADDRESS - Retrieve
Retrieve operation of resource: address
vrf-name
in path
string
ID of vrf-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
QUERIER-ADDRESS - Retrieve
Retrieve operation of resource: querier-address
vrf-name
in path
string
ID of vrf-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SUBSCRIBER-ADDRESS - Retrieve
Retrieve operation of resource: subscriber-address
vrf-name
in path
string
ID of vrf-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SSM-MAP-DETAILS - Retrieve
Retrieve operation of resource: ssm-map-details
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ssm-map-detail": [
{
"response-pending": "boolean",
"query-interval": "integer",
"map-info": {
"source-counts": "integer",
"map-type": "integer",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
},
"expiration-time": "integer",
"sources": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"elapsed-time": "integer"
}
]
}
SSM-MAP-DETAIL - Retrieve
Retrieve operation of resource: ssm-map-detail
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"response-pending": "boolean",
"query-interval": "integer",
"map-info": {
"source-counts": "integer",
"map-type": "integer",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
},
"expiration-time": "integer",
"sources": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"elapsed-time": "integer"
}
MAP-INFO - Retrieve
Retrieve operation of resource: map-info
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"source-counts": "integer",
"map-type": "integer",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
GROUP-ADDRESS-XR - Retrieve
Retrieve operation of resource: group-address-xr
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SOURCES - Retrieve
Retrieve operation of resource: sources
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
INTERFACE-STATE-OFFS - Retrieve
Retrieve operation of resource: interface-state-offs
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-state-off": [
{
"las-ll-remove-update-count": "integer",
"las-ll-add-update-count": "integer",
"las-update-count": "integer",
"configurationvrf-set": "boolean",
"vrf-id": "integer",
"subscriber-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"vrf-state": "integer",
"last-member-query-interval": "integer",
"interface-name-xr": "string",
"is-las-registered": "boolean",
"group-leaves": "integer",
"is-router-enabled": "boolean",
"las-get-address-count": "integer",
"subscriber-mode": "integer",
"total-active-groups": "integer",
"configuration-mcast-vrf-set": "boolean",
"querier-uptime": "integer",
"proxy-interface": "string",
"is-subscriber": "boolean",
"mte-vrf-id": "integer",
"state": "string",
"time-since-last-query-in-seconds": "integer",
"location": "integer",
"subscriber-id": "string",
"is-ip-enabled": "boolean",
"router-uptime-in-seconds": "integer",
"parent-ifhandle": "string",
"query-interval": "integer",
"configuration-mcast-vrf-error": "boolean",
"is-identity-present": "boolean",
"query-timeout": "integer",
"query-maximum-response-time": "integer",
"querier-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"igmp-version": "integer",
"las-ll-registration-count": "integer",
"is-interface-up": "boolean",
"mte-tuple-count": "integer",
"is-las-request": "boolean",
"prefix-length": "integer",
"las-null-update-count": "integer",
"is-querier": "boolean",
"robustness": "integer",
"las-unregistration-count": "integer",
"is-im-state-registered": "boolean",
"mtu": "integer",
"is-configurationverify": "boolean",
"time-since-last-report-in-seconds": "integer",
"configurationvrf-error": "boolean",
"host-version": "integer",
"group-joins": "integer"
}
]
}
INTERFACE-STATE-OFF - Retrieve
Retrieve operation of resource: interface-state-off
vrf-name
in path
string
ID of vrf-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"las-ll-remove-update-count": "integer",
"las-ll-add-update-count": "integer",
"las-update-count": "integer",
"configurationvrf-set": "boolean",
"vrf-id": "integer",
"subscriber-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"vrf-state": "integer",
"last-member-query-interval": "integer",
"interface-name-xr": "string",
"is-las-registered": "boolean",
"group-leaves": "integer",
"is-router-enabled": "boolean",
"las-get-address-count": "integer",
"subscriber-mode": "integer",
"total-active-groups": "integer",
"configuration-mcast-vrf-set": "boolean",
"querier-uptime": "integer",
"proxy-interface": "string",
"is-subscriber": "boolean",
"mte-vrf-id": "integer",
"state": "string",
"time-since-last-query-in-seconds": "integer",
"location": "integer",
"subscriber-id": "string",
"is-ip-enabled": "boolean",
"router-uptime-in-seconds": "integer",
"parent-ifhandle": "string",
"query-interval": "integer",
"configuration-mcast-vrf-error": "boolean",
"is-identity-present": "boolean",
"query-timeout": "integer",
"query-maximum-response-time": "integer",
"querier-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"igmp-version": "integer",
"las-ll-registration-count": "integer",
"is-interface-up": "boolean",
"mte-tuple-count": "integer",
"is-las-request": "boolean",
"prefix-length": "integer",
"las-null-update-count": "integer",
"is-querier": "boolean",
"robustness": "integer",
"las-unregistration-count": "integer",
"is-im-state-registered": "boolean",
"mtu": "integer",
"is-configurationverify": "boolean",
"time-since-last-report-in-seconds": "integer",
"configurationvrf-error": "boolean",
"host-version": "integer",
"group-joins": "integer"
}
ADDRESS - Retrieve
Retrieve operation of resource: address
vrf-name
in path
string
ID of vrf-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
QUERIER-ADDRESS - Retrieve
Retrieve operation of resource: querier-address
vrf-name
in path
string
ID of vrf-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SUBSCRIBER-ADDRESS - Retrieve
Retrieve operation of resource: subscriber-address
vrf-name
in path
string
ID of vrf-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
PROCESS - Retrieve
Retrieve operation of resource: process
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"amt-gateways": {
"amt-gateway": [
{
"amt-nonce": "integer",
"amtgw": "string",
"mem-upd-in": "integer",
"key-len": "integer",
"mem-upd-out": "integer",
"amtnh": "integer",
"amt-port": "integer",
"idb": "integer"
}
]
},
"unicast-qos-adjust-stats": {
"is-qos-s-sweeped": "boolean",
"batches": "integer",
"send-errors": "integer",
"last-download-time": "integer",
"sent-resync-bulks": "integer",
"is-resync-required": "boolean",
"queues": "integer",
"is-resync-start-sent": "boolean",
"send-partial-errors": "integer",
"last-sweep-time": "integer",
"send-success": "integer",
"is-resync-received": "boolean",
"add-to-batches": "integer",
"received-resync-requests": "integer",
"send-comm-errors": "integer",
"delete-to-batches": "integer"
},
"amt-summary": {
"gateway-count": "integer",
"prefix-length": "integer",
"anycast-prefix": "string",
"query-interval": "integer",
"relay-address": "string",
"tos": "integer",
"mtu": "integer",
"tunnel-count": "integer",
"tunnel-configured-maximum": "integer",
"ttl": "integer",
"is-acl-configured": "boolean",
"max-gateway": "integer",
"is-gateway-simulation": "boolean",
"is-ou-of-resource": "boolean"
},
"nsf": {
"last-nsf-off": "string",
"last-icd-notif-recv-min": "string",
"multicast-nsf-time-left": "integer",
"is-multicast-nsf-active": "boolean",
"last-icd-notif-recv": "string",
"multicast-nsf-timeout": "integer",
"respawn-count": "integer",
"last-nsf-on-min": "string",
"last-nsf-on": "string",
"last-nsf-off-min": "string"
},
"bvi-statistics": {
"tx-unknown-mrouter-msg": "integer",
"send-blocks": "integer",
"tx-protocol-buffers": "integer",
"rx-ipc-close-notif": "integer",
"rx-ipc-publish-notif": "integer",
"wtx-msg-proto-sent": "integer",
"rx-igmp-packet-success": "integer",
"rx-ipc-open-notif": "integer",
"rx-sweep-mrouter-msg": "integer",
"rx-ipc-lwm-notif": "integer",
"wtx-msg-drop-nomem": "integer",
"rx-delete-mrouter-msg": "integer",
"wtx-msg-freed": "integer",
"rx-ipc-q-full-notif": "integer",
"receive-buffers": "integer",
"rx-add-mrouter-msg": "integer",
"tx-add-mrouter-msg": "integer",
"rx-ipc-input-wait-notif": "integer",
"tx-sweep-mrouter-msg": "integer",
"tx-unknown-buffers": "integer",
"rx-ipc-send-status-notif": "integer",
"rx-ipc-output-notif": "integer",
"wtx-msg-drop-dc": "integer",
"null-buffer-handles": "integer",
"tx-delete-mrouter-msg": "integer",
"rx-ipc-error-notif": "integer",
"rx-unknown-mrouter-msg": "integer",
"release-buffers": "integer",
"release-fail-buffers": "integer",
"tx-buffer-errors": "integer",
"tx-mrouter-buffers": "integer",
"tx-buffers": "integer",
"wtx-msg-recvd": "integer",
"wtx-msg-sent": "integer",
"rx-ipc-connect-notif": "integer"
},
"nsr": {
"collab-conv-done": "boolean"
}
}
AMT-SUMMARY - Retrieve
Retrieve operation of resource: amt-summary
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"gateway-count": "integer",
"prefix-length": "integer",
"anycast-prefix": "string",
"query-interval": "integer",
"relay-address": "string",
"tos": "integer",
"mtu": "integer",
"tunnel-count": "integer",
"tunnel-configured-maximum": "integer",
"ttl": "integer",
"is-acl-configured": "boolean",
"max-gateway": "integer",
"is-gateway-simulation": "boolean",
"is-ou-of-resource": "boolean"
}
NSR - Retrieve
Retrieve operation of resource: nsr
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"collab-conv-done": "boolean",
"rmf-notification-done": "boolean",
"last-rmf-not-ready": "integer",
"count-proc-connection-dn": "integer",
"count-rmf-ready": "integer",
"state": "integer",
"count-proc-connection-up": "integer",
"last-proc": "integer",
"count-rmf-not-ready": "integer",
"last-proc-connection-up": "integer",
"last-proc-connection-dn": "integer",
"last-rmf-ready": "integer",
"partner-proc-connected": "boolean"
}
AMT-GATEWAYS - Retrieve
Retrieve operation of resource: amt-gateways
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"amt-gateway": [
{
"amt-nonce": "integer",
"amtgw": "string",
"mem-upd-in": "integer",
"key-len": "integer",
"mem-upd-out": "integer",
"amtnh": "integer",
"amt-port": "integer",
"idb": "integer"
}
]
}
AMT-GATEWAY - Retrieve
Retrieve operation of resource: amt-gateway
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"amt-nonce": "integer",
"amtgw": "string",
"mem-upd-in": "integer",
"key-len": "integer",
"mem-upd-out": "integer",
"amtnh": "integer",
"amt-port": "integer",
"idb": "integer"
}
UNICAST-QOS-ADJUST-STATS - Retrieve
Retrieve operation of resource: unicast-qos-adjust-stats
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-qos-s-sweeped": "boolean",
"batches": "integer",
"send-errors": "integer",
"last-download-time": "integer",
"sent-resync-bulks": "integer",
"is-resync-required": "boolean",
"queues": "integer",
"is-resync-start-sent": "boolean",
"send-partial-errors": "integer",
"last-sweep-time": "integer",
"send-success": "integer",
"is-resync-received": "boolean",
"add-to-batches": "integer",
"received-resync-requests": "integer",
"send-comm-errors": "integer",
"delete-to-batches": "integer"
}
BVI-STATISTICS - Retrieve
Retrieve operation of resource: bvi-statistics
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"tx-unknown-mrouter-msg": "integer",
"send-blocks": "integer",
"tx-protocol-buffers": "integer",
"rx-ipc-close-notif": "integer",
"rx-ipc-publish-notif": "integer",
"wtx-msg-proto-sent": "integer",
"rx-igmp-packet-success": "integer",
"rx-ipc-open-notif": "integer",
"rx-sweep-mrouter-msg": "integer",
"rx-ipc-lwm-notif": "integer",
"wtx-msg-drop-nomem": "integer",
"rx-delete-mrouter-msg": "integer",
"wtx-msg-freed": "integer",
"rx-ipc-q-full-notif": "integer",
"receive-buffers": "integer",
"rx-add-mrouter-msg": "integer",
"tx-add-mrouter-msg": "integer",
"rx-ipc-input-wait-notif": "integer",
"tx-sweep-mrouter-msg": "integer",
"tx-unknown-buffers": "integer",
"rx-ipc-send-status-notif": "integer",
"rx-ipc-output-notif": "integer",
"wtx-msg-drop-dc": "integer",
"null-buffer-handles": "integer",
"tx-delete-mrouter-msg": "integer",
"rx-ipc-error-notif": "integer",
"rx-unknown-mrouter-msg": "integer",
"release-buffers": "integer",
"release-fail-buffers": "integer",
"tx-buffer-errors": "integer",
"tx-mrouter-buffers": "integer",
"tx-buffers": "integer",
"wtx-msg-recvd": "integer",
"wtx-msg-sent": "integer",
"rx-ipc-connect-notif": "integer"
}
NSF - Retrieve
Retrieve operation of resource: nsf
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"last-nsf-off": "string",
"last-icd-notif-recv-min": "string",
"multicast-nsf-time-left": "integer",
"is-multicast-nsf-active": "boolean",
"last-icd-notif-recv": "string",
"multicast-nsf-timeout": "integer",
"respawn-count": "integer",
"last-nsf-on-min": "string",
"last-nsf-on": "string",
"last-nsf-off-min": "string"
}
DEFAULT-CONTEXT - Retrieve
Retrieve operation of resource: default-context
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-state-offs": {
"interface-state-off": [
{
"interface-name": "string",
"las-ll-remove-update-count": "integer",
"las-ll-add-update-count": "integer",
"las-update-count": "integer",
"configurationvrf-set": "boolean",
"vrf-id": "integer",
"subscriber-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"vrf-state": "integer",
"last-member-query-interval": "integer",
"interface-name-xr": "string",
"is-las-registered": "boolean",
"group-leaves": "integer",
"is-router-enabled": "boolean",
"las-get-address-count": "integer",
"subscriber-mode": "integer",
"total-active-groups": "integer",
"configuration-mcast-vrf-set": "boolean",
"querier-uptime": "integer",
"proxy-interface": "string",
"is-subscriber": "boolean",
"mte-vrf-id": "integer",
"state": "string",
"time-since-last-query-in-seconds": "integer",
"location": "integer",
"subscriber-id": "string",
"is-ip-enabled": "boolean",
"router-uptime-in-seconds": "integer",
"parent-ifhandle": "string",
"query-interval": "integer",
"configuration-mcast-vrf-error": "boolean",
"is-identity-present": "boolean",
"query-timeout": "integer",
"query-maximum-response-time": "integer",
"querier-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"igmp-version": "integer",
"las-ll-registration-count": "integer",
"is-interface-up": "boolean",
"mte-tuple-count": "integer",
"is-las-request": "boolean",
"prefix-length": "integer",
"las-null-update-count": "integer",
"is-querier": "boolean",
"robustness": "integer",
"las-unregistration-count": "integer",
"is-im-state-registered": "boolean",
"mtu": "integer",
"is-configurationverify": "boolean",
"time-since-last-report-in-seconds": "integer",
"configurationvrf-error": "boolean",
"host-version": "integer",
"group-joins": "integer"
}
]
}
}
SUMMARY - Retrieve
Retrieve operation of resource: summary
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"group-count": "integer",
"disabled-interface-count": "integer",
"group-limit": "integer",
"supported-interfaces": "integer",
"robustness": "integer",
"is-disabled": "boolean",
"enabled-interface-count": "integer",
"node-low-memory": "boolean",
"unsupported-interfaces": "integer",
"tunnel-mte-config-count": "integer",
"interface": [
{
"group-count": "integer",
"parent-ifhandle": "string",
"router-uptime-in-seconds": "integer",
"interface-name": "string",
"group-limit": "integer",
"on-off": "boolean",
"time-since-last-report-in-seconds": "integer",
"time-since-last-query-in-seconds": "integer"
}
]
}
INTERFACE - Retrieve
Retrieve operation of resource: interface
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"group-count": "integer",
"parent-ifhandle": "string",
"router-uptime-in-seconds": "integer",
"interface-name": "string",
"group-limit": "integer",
"on-off": "boolean",
"time-since-last-report-in-seconds": "integer",
"time-since-last-query-in-seconds": "integer"
}
INTERFACE-STATE-ONS - Retrieve
Retrieve operation of resource: interface-state-ons
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-state-on": [
{
"las-ll-remove-update-count": "integer",
"las-ll-add-update-count": "integer",
"las-update-count": "integer",
"configurationvrf-set": "boolean",
"vrf-id": "integer",
"subscriber-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"vrf-state": "integer",
"last-member-query-interval": "integer",
"interface-name-xr": "string",
"is-las-registered": "boolean",
"group-leaves": "integer",
"is-router-enabled": "boolean",
"las-get-address-count": "integer",
"subscriber-mode": "integer",
"total-active-groups": "integer",
"configuration-mcast-vrf-set": "boolean",
"querier-uptime": "integer",
"proxy-interface": "string",
"is-subscriber": "boolean",
"mte-vrf-id": "integer",
"state": "string",
"time-since-last-query-in-seconds": "integer",
"location": "integer",
"subscriber-id": "string",
"is-ip-enabled": "boolean",
"router-uptime-in-seconds": "integer",
"parent-ifhandle": "string",
"query-interval": "integer",
"configuration-mcast-vrf-error": "boolean",
"is-identity-present": "boolean",
"query-timeout": "integer",
"query-maximum-response-time": "integer",
"querier-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"igmp-version": "integer",
"las-ll-registration-count": "integer",
"is-interface-up": "boolean",
"mte-tuple-count": "integer",
"is-las-request": "boolean",
"prefix-length": "integer",
"las-null-update-count": "integer",
"is-querier": "boolean",
"robustness": "integer",
"las-unregistration-count": "integer",
"is-im-state-registered": "boolean",
"mtu": "integer",
"is-configurationverify": "boolean",
"time-since-last-report-in-seconds": "integer",
"configurationvrf-error": "boolean",
"host-version": "integer",
"group-joins": "integer"
}
]
}
INTERFACE-STATE-ON - Retrieve
Retrieve operation of resource: interface-state-on
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"las-ll-remove-update-count": "integer",
"las-ll-add-update-count": "integer",
"las-update-count": "integer",
"configurationvrf-set": "boolean",
"vrf-id": "integer",
"subscriber-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"vrf-state": "integer",
"last-member-query-interval": "integer",
"interface-name-xr": "string",
"is-las-registered": "boolean",
"group-leaves": "integer",
"is-router-enabled": "boolean",
"las-get-address-count": "integer",
"subscriber-mode": "integer",
"total-active-groups": "integer",
"configuration-mcast-vrf-set": "boolean",
"querier-uptime": "integer",
"proxy-interface": "string",
"is-subscriber": "boolean",
"mte-vrf-id": "integer",
"state": "string",
"time-since-last-query-in-seconds": "integer",
"location": "integer",
"subscriber-id": "string",
"is-ip-enabled": "boolean",
"router-uptime-in-seconds": "integer",
"parent-ifhandle": "string",
"query-interval": "integer",
"configuration-mcast-vrf-error": "boolean",
"is-identity-present": "boolean",
"query-timeout": "integer",
"query-maximum-response-time": "integer",
"querier-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"igmp-version": "integer",
"las-ll-registration-count": "integer",
"is-interface-up": "boolean",
"mte-tuple-count": "integer",
"is-las-request": "boolean",
"prefix-length": "integer",
"las-null-update-count": "integer",
"is-querier": "boolean",
"robustness": "integer",
"las-unregistration-count": "integer",
"is-im-state-registered": "boolean",
"mtu": "integer",
"is-configurationverify": "boolean",
"time-since-last-report-in-seconds": "integer",
"configurationvrf-error": "boolean",
"host-version": "integer",
"group-joins": "integer"
}
ADDRESS - Retrieve
Retrieve operation of resource: address
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
QUERIER-ADDRESS - Retrieve
Retrieve operation of resource: querier-address
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SUBSCRIBER-ADDRESS - Retrieve
Retrieve operation of resource: subscriber-address
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
DETAIL-GROUPS - Retrieve
Retrieve operation of resource: detail-groups
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"detail-group": [
{
"source": [
{
"uptime": "integer",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"expiration-time": "string",
"is-local": "boolean",
"is-forward": "boolean",
"is-added": "boolean",
"flags": "string",
"is-remote": "boolean",
"is-we-report": "boolean"
}
],
"is-router-exclude-mode": "boolean",
"group-info": {
"uptime": "integer",
"older-host-version1-timer": "integer",
"row-status": "string",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-added": "boolean",
"older-host-version2-timer": "integer",
"last-reporter": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"expiration-time": "string",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-suppressed": "boolean",
"is-self-join": "boolean",
"is-low-memory": "boolean",
"interface-name-xr": "string",
"router-filter-mode": "integer",
"explicit-tracking-enabled": "boolean"
},
"is-host-exclude-mode": "boolean"
}
]
}
DETAIL-GROUP - Retrieve
Retrieve operation of resource: detail-group
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"source": [
{
"uptime": "integer",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"expiration-time": "string",
"is-local": "boolean",
"is-forward": "boolean",
"is-added": "boolean",
"flags": "string",
"is-remote": "boolean",
"is-we-report": "boolean"
}
],
"is-router-exclude-mode": "boolean",
"group-info": {
"uptime": "integer",
"older-host-version1-timer": "integer",
"row-status": "string",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-added": "boolean",
"older-host-version2-timer": "integer",
"last-reporter": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"expiration-time": "string",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-suppressed": "boolean",
"is-self-join": "boolean",
"is-low-memory": "boolean",
"interface-name-xr": "string",
"router-filter-mode": "integer",
"explicit-tracking-enabled": "boolean"
},
"is-host-exclude-mode": "boolean"
}
GROUP-INFO - Retrieve
Retrieve operation of resource: group-info
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"uptime": "integer",
"older-host-version1-timer": "integer",
"row-status": "string",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-added": "boolean",
"older-host-version2-timer": "integer",
"last-reporter": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"expiration-time": "string",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-suppressed": "boolean",
"is-self-join": "boolean",
"is-low-memory": "boolean",
"interface-name-xr": "string",
"router-filter-mode": "integer",
"explicit-tracking-enabled": "boolean"
}
GROUP-ADDRESS-XR - Retrieve
Retrieve operation of resource: group-address-xr
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
LAST-REPORTER - Retrieve
Retrieve operation of resource: last-reporter
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SOURCE-ADDRESS - Retrieve
Retrieve operation of resource: source-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SOURCE - Retrieve
Retrieve operation of resource: source
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"uptime": "integer",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"expiration-time": "string",
"is-local": "boolean",
"is-forward": "boolean",
"is-added": "boolean",
"flags": "string",
"is-remote": "boolean",
"is-we-report": "boolean"
}
SOURCE-ADDRESS - Retrieve
Retrieve operation of resource: source-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
NON-ACTIVE-GROUPS - Retrieve
Retrieve operation of resource: non-active-groups
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"non-active-groups": [
{
"interface": "string",
"group-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"reason-for-non-activity": "string",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
}
NON-ACTIVE-GROUPS - Retrieve
Retrieve operation of resource: non-active-groups
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface": "string",
"group-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"reason-for-non-activity": "string",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
GROUP-ADDRESS - Retrieve
Retrieve operation of resource: group-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SOURCE-ADDRESS - Retrieve
Retrieve operation of resource: source-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SSM-MAPS - Retrieve
Retrieve operation of resource: ssm-maps
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ssm-map": [
{
"source-counts": "integer",
"map-type": "integer",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
}
SSM-MAP - Retrieve
Retrieve operation of resource: ssm-map
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"source-counts": "integer",
"map-type": "integer",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
GROUP-ADDRESS-XR - Retrieve
Retrieve operation of resource: group-address-xr
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
EXPLICIT-GROUPS - Retrieve
Retrieve operation of resource: explicit-groups
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"explicit-group": [
{
"exclude-hosts": "integer",
"host": [
{
"uptime": "integer",
"source-address": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"is-exclude": "boolean",
"expiration-time": "integer",
"source-count": "integer",
"address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
],
"include-hosts": "integer",
"group-info": {
"uptime": "integer",
"older-host-version1-timer": "integer",
"row-status": "string",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-added": "boolean",
"older-host-version2-timer": "integer",
"last-reporter": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"expiration-time": "string",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-suppressed": "boolean",
"is-self-join": "boolean",
"is-low-memory": "boolean",
"interface-name-xr": "string",
"router-filter-mode": "integer",
"explicit-tracking-enabled": "boolean"
}
}
]
}
EXPLICIT-GROUP - Retrieve
Retrieve operation of resource: explicit-group
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"exclude-hosts": "integer",
"host": [
{
"uptime": "integer",
"source-address": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"is-exclude": "boolean",
"expiration-time": "integer",
"source-count": "integer",
"address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
],
"include-hosts": "integer",
"group-info": {
"uptime": "integer",
"older-host-version1-timer": "integer",
"row-status": "string",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-added": "boolean",
"older-host-version2-timer": "integer",
"last-reporter": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"expiration-time": "string",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-suppressed": "boolean",
"is-self-join": "boolean",
"is-low-memory": "boolean",
"interface-name-xr": "string",
"router-filter-mode": "integer",
"explicit-tracking-enabled": "boolean"
}
}
GROUP-INFO - Retrieve
Retrieve operation of resource: group-info
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"uptime": "integer",
"older-host-version1-timer": "integer",
"row-status": "string",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-added": "boolean",
"older-host-version2-timer": "integer",
"last-reporter": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"expiration-time": "string",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-suppressed": "boolean",
"is-self-join": "boolean",
"is-low-memory": "boolean",
"interface-name-xr": "string",
"router-filter-mode": "integer",
"explicit-tracking-enabled": "boolean"
}
GROUP-ADDRESS-XR - Retrieve
Retrieve operation of resource: group-address-xr
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
LAST-REPORTER - Retrieve
Retrieve operation of resource: last-reporter
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SOURCE-ADDRESS - Retrieve
Retrieve operation of resource: source-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
HOST - Retrieve
Retrieve operation of resource: host
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"uptime": "integer",
"source-address": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"is-exclude": "boolean",
"expiration-time": "integer",
"source-count": "integer",
"address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
ADDRESS - Retrieve
Retrieve operation of resource: address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SOURCE-ADDRESS - Retrieve
Retrieve operation of resource: source-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
INTERFACE-TABLE - Retrieve
Retrieve operation of resource: interface-table
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface": [
{
"interface-name": "string",
"las-ll-remove-update-count": "integer",
"las-ll-add-update-count": "integer",
"las-update-count": "integer",
"configurationvrf-set": "boolean",
"vrf-id": "integer",
"subscriber-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"vrf-state": "integer",
"last-member-query-interval": "integer",
"interface-name-xr": "string",
"is-las-registered": "boolean",
"group-leaves": "integer",
"is-router-enabled": "boolean",
"las-get-address-count": "integer",
"subscriber-mode": "integer",
"total-active-groups": "integer",
"configuration-mcast-vrf-set": "boolean",
"querier-uptime": "integer",
"proxy-interface": "string",
"is-subscriber": "boolean",
"mte-vrf-id": "integer",
"state": "string",
"time-since-last-query-in-seconds": "integer",
"location": "integer",
"subscriber-id": "string",
"is-ip-enabled": "boolean",
"router-uptime-in-seconds": "integer",
"parent-ifhandle": "string",
"query-interval": "integer",
"configuration-mcast-vrf-error": "boolean",
"is-identity-present": "boolean",
"query-timeout": "integer",
"query-maximum-response-time": "integer",
"querier-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"igmp-version": "integer",
"las-ll-registration-count": "integer",
"is-interface-up": "boolean",
"mte-tuple-count": "integer",
"is-las-request": "boolean",
"prefix-length": "integer",
"las-null-update-count": "integer",
"is-querier": "boolean",
"robustness": "integer",
"las-unregistration-count": "integer",
"is-im-state-registered": "boolean",
"mtu": "integer",
"is-configurationverify": "boolean",
"time-since-last-report-in-seconds": "integer",
"configurationvrf-error": "boolean",
"host-version": "integer",
"group-joins": "integer"
}
]
}
INTERFACE - Retrieve
Retrieve operation of resource: interface
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"las-ll-remove-update-count": "integer",
"las-ll-add-update-count": "integer",
"las-update-count": "integer",
"configurationvrf-set": "boolean",
"vrf-id": "integer",
"subscriber-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"vrf-state": "integer",
"last-member-query-interval": "integer",
"interface-name-xr": "string",
"is-las-registered": "boolean",
"group-leaves": "integer",
"is-router-enabled": "boolean",
"las-get-address-count": "integer",
"subscriber-mode": "integer",
"total-active-groups": "integer",
"configuration-mcast-vrf-set": "boolean",
"querier-uptime": "integer",
"proxy-interface": "string",
"is-subscriber": "boolean",
"mte-vrf-id": "integer",
"state": "string",
"time-since-last-query-in-seconds": "integer",
"location": "integer",
"subscriber-id": "string",
"is-ip-enabled": "boolean",
"router-uptime-in-seconds": "integer",
"parent-ifhandle": "string",
"query-interval": "integer",
"configuration-mcast-vrf-error": "boolean",
"is-identity-present": "boolean",
"query-timeout": "integer",
"query-maximum-response-time": "integer",
"querier-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"igmp-version": "integer",
"las-ll-registration-count": "integer",
"is-interface-up": "boolean",
"mte-tuple-count": "integer",
"is-las-request": "boolean",
"prefix-length": "integer",
"las-null-update-count": "integer",
"is-querier": "boolean",
"robustness": "integer",
"las-unregistration-count": "integer",
"is-im-state-registered": "boolean",
"mtu": "integer",
"is-configurationverify": "boolean",
"time-since-last-report-in-seconds": "integer",
"configurationvrf-error": "boolean",
"host-version": "integer",
"group-joins": "integer"
}
ADDRESS - Retrieve
Retrieve operation of resource: address
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
QUERIER-ADDRESS - Retrieve
Retrieve operation of resource: querier-address
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SUBSCRIBER-ADDRESS - Retrieve
Retrieve operation of resource: subscriber-address
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
INTERFACE-UNICAST-QOS-ADJUSTS - Retrieve
Retrieve operation of resource: interface-unicast-qos-adjusts
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-unicast-qos-adjust": [
{
"is-virtual-access": "boolean",
"rate": "integer",
"rate-increments": "integer",
"rate-decrements": "integer",
"update": [
{
"is-add": "boolean",
"group-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"received-time": "integer",
"weight": "integer",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
}
]
}
INTERFACE-UNICAST-QOS-ADJUST - Retrieve
Retrieve operation of resource: interface-unicast-qos-adjust
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-virtual-access": "boolean",
"rate": "integer",
"rate-increments": "integer",
"rate-decrements": "integer",
"update": [
{
"is-add": "boolean",
"group-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"received-time": "integer",
"weight": "integer",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
}
UPDATE - Retrieve
Retrieve operation of resource: update
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-add": "boolean",
"group-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"received-time": "integer",
"weight": "integer",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
SOURCE-ADDRESS - Retrieve
Retrieve operation of resource: source-address
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
GROUP-ADDRESS - Retrieve
Retrieve operation of resource: group-address
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
RANGES - Retrieve
Retrieve operation of resource: ranges
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"range": [
{
"is-stale": "boolean",
"protocol": "string",
"prefix-length": "integer",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
}
RANGE - Retrieve
Retrieve operation of resource: range
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-stale": "boolean",
"protocol": "string",
"prefix-length": "integer",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
GROUP-ADDRESS-XR - Retrieve
Retrieve operation of resource: group-address-xr
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
IFRS-INTERFACES - Retrieve
Retrieve operation of resource: ifrs-interfaces
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ifrs-interface": [
{
"join-group-count": "integer",
"igmp-interface-entry": {
"las-ll-remove-update-count": "integer",
"las-ll-add-update-count": "integer",
"las-update-count": "integer",
"configurationvrf-set": "boolean",
"vrf-id": "integer",
"subscriber-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"vrf-state": "integer",
"last-member-query-interval": "integer",
"interface-name-xr": "string",
"is-las-registered": "boolean",
"group-leaves": "integer",
"is-router-enabled": "boolean",
"las-get-address-count": "integer",
"subscriber-mode": "integer",
"total-active-groups": "integer",
"configuration-mcast-vrf-set": "boolean",
"querier-uptime": "integer",
"proxy-interface": "string",
"is-subscriber": "boolean",
"mte-vrf-id": "integer",
"state": "string",
"time-since-last-query-in-seconds": "integer",
"location": "integer",
"subscriber-id": "string",
"is-ip-enabled": "boolean",
"router-uptime-in-seconds": "integer",
"parent-ifhandle": "string",
"query-interval": "integer",
"configuration-mcast-vrf-error": "boolean",
"is-identity-present": "boolean",
"query-timeout": "integer",
"query-maximum-response-time": "integer",
"querier-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"igmp-version": "integer",
"las-ll-registration-count": "integer",
"is-interface-up": "boolean",
"mte-tuple-count": "integer",
"is-las-request": "boolean",
"prefix-length": "integer",
"las-null-update-count": "integer",
"is-querier": "boolean",
"robustness": "integer",
"las-unregistration-count": "integer",
"is-im-state-registered": "boolean",
"mtu": "integer",
"is-configurationverify": "boolean",
"time-since-last-report-in-seconds": "integer",
"configurationvrf-error": "boolean",
"host-version": "integer",
"group-joins": "integer"
}
}
]
}
IFRS-INTERFACE - Retrieve
Retrieve operation of resource: ifrs-interface
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"join-group-count": "integer",
"igmp-interface-entry": {
"las-ll-remove-update-count": "integer",
"las-ll-add-update-count": "integer",
"las-update-count": "integer",
"configurationvrf-set": "boolean",
"vrf-id": "integer",
"subscriber-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"vrf-state": "integer",
"last-member-query-interval": "integer",
"interface-name-xr": "string",
"is-las-registered": "boolean",
"group-leaves": "integer",
"is-router-enabled": "boolean",
"las-get-address-count": "integer",
"subscriber-mode": "integer",
"total-active-groups": "integer",
"configuration-mcast-vrf-set": "boolean",
"querier-uptime": "integer",
"proxy-interface": "string",
"is-subscriber": "boolean",
"mte-vrf-id": "integer",
"state": "string",
"time-since-last-query-in-seconds": "integer",
"location": "integer",
"subscriber-id": "string",
"is-ip-enabled": "boolean",
"router-uptime-in-seconds": "integer",
"parent-ifhandle": "string",
"query-interval": "integer",
"configuration-mcast-vrf-error": "boolean",
"is-identity-present": "boolean",
"query-timeout": "integer",
"query-maximum-response-time": "integer",
"querier-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"igmp-version": "integer",
"las-ll-registration-count": "integer",
"is-interface-up": "boolean",
"mte-tuple-count": "integer",
"is-las-request": "boolean",
"prefix-length": "integer",
"las-null-update-count": "integer",
"is-querier": "boolean",
"robustness": "integer",
"las-unregistration-count": "integer",
"is-im-state-registered": "boolean",
"mtu": "integer",
"is-configurationverify": "boolean",
"time-since-last-report-in-seconds": "integer",
"configurationvrf-error": "boolean",
"host-version": "integer",
"group-joins": "integer"
}
}
IGMP-INTERFACE-ENTRY - Retrieve
Retrieve operation of resource: igmp-interface-entry
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"las-ll-remove-update-count": "integer",
"las-ll-add-update-count": "integer",
"las-update-count": "integer",
"configurationvrf-set": "boolean",
"vrf-id": "integer",
"subscriber-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"vrf-state": "integer",
"last-member-query-interval": "integer",
"interface-name-xr": "string",
"is-las-registered": "boolean",
"group-leaves": "integer",
"is-router-enabled": "boolean",
"las-get-address-count": "integer",
"subscriber-mode": "integer",
"total-active-groups": "integer",
"configuration-mcast-vrf-set": "boolean",
"querier-uptime": "integer",
"proxy-interface": "string",
"is-subscriber": "boolean",
"mte-vrf-id": "integer",
"state": "string",
"time-since-last-query-in-seconds": "integer",
"location": "integer",
"subscriber-id": "string",
"is-ip-enabled": "boolean",
"router-uptime-in-seconds": "integer",
"parent-ifhandle": "string",
"query-interval": "integer",
"configuration-mcast-vrf-error": "boolean",
"is-identity-present": "boolean",
"query-timeout": "integer",
"query-maximum-response-time": "integer",
"querier-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"igmp-version": "integer",
"las-ll-registration-count": "integer",
"is-interface-up": "boolean",
"mte-tuple-count": "integer",
"is-las-request": "boolean",
"prefix-length": "integer",
"las-null-update-count": "integer",
"is-querier": "boolean",
"robustness": "integer",
"las-unregistration-count": "integer",
"is-im-state-registered": "boolean",
"mtu": "integer",
"is-configurationverify": "boolean",
"time-since-last-report-in-seconds": "integer",
"configurationvrf-error": "boolean",
"host-version": "integer",
"group-joins": "integer"
}
ADDRESS - Retrieve
Retrieve operation of resource: address
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
QUERIER-ADDRESS - Retrieve
Retrieve operation of resource: querier-address
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SUBSCRIBER-ADDRESS - Retrieve
Retrieve operation of resource: subscriber-address
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
TRAFFIC-COUNTERS - Retrieve
Retrieve operation of resource: traffic-counters
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"checksum-errors": "integer",
"auxillary-data-length-errors": "integer",
"input-mtrace": "integer",
"socket-errors": "integer",
"packet-manager-input-errors": "integer",
"packets-out": "integer",
"input-no-idb": "integer",
"output-no-parent-interface-handle": "integer",
"receive-socket-errors": "integer",
"output-leaves": "integer",
"no-socket-connection": "integer",
"bad-scope-errors": "integer",
"input-leaves": "integer",
"invalid-source-address-errors": "integer",
"get-packet-failure": "integer",
"input-dvmrp": "integer",
"miscellaneous-errors": "integer",
"elapsed-time": "integer",
"input-no-platform-support-mtrace": "integer",
"input-queries": "integer",
"output-pim": "integer",
"input-disabled-idb": "integer",
"packet-manager-output-errors": "integer",
"format-errors": "integer",
"packets-in": "integer",
"input-no-vrf-mtrace": "integer",
"input-no-assigned-vrf-id": "integer",
"input-reports": "integer",
"input-pim": "integer",
"input-martian-address": "integer",
"output-queries": "integer",
"input-no-vrf-in-idb": "integer",
"output-mtrace": "integer",
"output-reports": "integer",
"output-dvmrp": "integer"
}
GROUPS - Retrieve
Retrieve operation of resource: groups
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"group": [
{
"uptime": "integer",
"older-host-version1-timer": "integer",
"row-status": "string",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-added": "boolean",
"older-host-version2-timer": "integer",
"last-reporter": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"expiration-time": "string",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-suppressed": "boolean",
"is-self-join": "boolean",
"is-low-memory": "boolean",
"interface-name-xr": "string",
"router-filter-mode": "integer",
"explicit-tracking-enabled": "boolean"
}
]
}
GROUP - Retrieve
Retrieve operation of resource: group
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"uptime": "integer",
"older-host-version1-timer": "integer",
"row-status": "string",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-added": "boolean",
"older-host-version2-timer": "integer",
"last-reporter": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"expiration-time": "string",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-suppressed": "boolean",
"is-self-join": "boolean",
"is-low-memory": "boolean",
"interface-name-xr": "string",
"router-filter-mode": "integer",
"explicit-tracking-enabled": "boolean"
}
GROUP-ADDRESS-XR - Retrieve
Retrieve operation of resource: group-address-xr
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
LAST-REPORTER - Retrieve
Retrieve operation of resource: last-reporter
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SOURCE-ADDRESS - Retrieve
Retrieve operation of resource: source-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
GROUP-SUMMARY - Retrieve
Retrieve operation of resource: group-summary
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"group-count": "integer",
"groutes": "integer",
"sg-routes": "integer",
"is-low-memory": "boolean"
}
IFRS-INTERFACE-SUMMARY - Retrieve
Retrieve operation of resource: ifrs-interface-summary
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-count": "integer",
"configuration-count": "integer"
}
GLOBAL-INTERFACE-TABLE - Retrieve
Retrieve operation of resource: global-interface-table
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface": [
{
"interface-name": "string",
"las-ll-remove-update-count": "integer",
"las-ll-add-update-count": "integer",
"las-update-count": "integer",
"configurationvrf-set": "boolean",
"vrf-id": "integer",
"subscriber-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"vrf-state": "integer",
"last-member-query-interval": "integer",
"interface-name-xr": "string",
"is-las-registered": "boolean",
"group-leaves": "integer",
"is-router-enabled": "boolean",
"las-get-address-count": "integer",
"subscriber-mode": "integer",
"total-active-groups": "integer",
"configuration-mcast-vrf-set": "boolean",
"querier-uptime": "integer",
"proxy-interface": "string",
"is-subscriber": "boolean",
"mte-vrf-id": "integer",
"state": "string",
"time-since-last-query-in-seconds": "integer",
"location": "integer",
"subscriber-id": "string",
"is-ip-enabled": "boolean",
"router-uptime-in-seconds": "integer",
"parent-ifhandle": "string",
"query-interval": "integer",
"configuration-mcast-vrf-error": "boolean",
"is-identity-present": "boolean",
"query-timeout": "integer",
"query-maximum-response-time": "integer",
"querier-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"igmp-version": "integer",
"las-ll-registration-count": "integer",
"is-interface-up": "boolean",
"mte-tuple-count": "integer",
"is-las-request": "boolean",
"prefix-length": "integer",
"las-null-update-count": "integer",
"is-querier": "boolean",
"robustness": "integer",
"las-unregistration-count": "integer",
"is-im-state-registered": "boolean",
"mtu": "integer",
"is-configurationverify": "boolean",
"time-since-last-report-in-seconds": "integer",
"configurationvrf-error": "boolean",
"host-version": "integer",
"group-joins": "integer"
}
]
}
INTERFACE - Retrieve
Retrieve operation of resource: interface
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"las-ll-remove-update-count": "integer",
"las-ll-add-update-count": "integer",
"las-update-count": "integer",
"configurationvrf-set": "boolean",
"vrf-id": "integer",
"subscriber-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"vrf-state": "integer",
"last-member-query-interval": "integer",
"interface-name-xr": "string",
"is-las-registered": "boolean",
"group-leaves": "integer",
"is-router-enabled": "boolean",
"las-get-address-count": "integer",
"subscriber-mode": "integer",
"total-active-groups": "integer",
"configuration-mcast-vrf-set": "boolean",
"querier-uptime": "integer",
"proxy-interface": "string",
"is-subscriber": "boolean",
"mte-vrf-id": "integer",
"state": "string",
"time-since-last-query-in-seconds": "integer",
"location": "integer",
"subscriber-id": "string",
"is-ip-enabled": "boolean",
"router-uptime-in-seconds": "integer",
"parent-ifhandle": "string",
"query-interval": "integer",
"configuration-mcast-vrf-error": "boolean",
"is-identity-present": "boolean",
"query-timeout": "integer",
"query-maximum-response-time": "integer",
"querier-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"igmp-version": "integer",
"las-ll-registration-count": "integer",
"is-interface-up": "boolean",
"mte-tuple-count": "integer",
"is-las-request": "boolean",
"prefix-length": "integer",
"las-null-update-count": "integer",
"is-querier": "boolean",
"robustness": "integer",
"las-unregistration-count": "integer",
"is-im-state-registered": "boolean",
"mtu": "integer",
"is-configurationverify": "boolean",
"time-since-last-report-in-seconds": "integer",
"configurationvrf-error": "boolean",
"host-version": "integer",
"group-joins": "integer"
}
ADDRESS - Retrieve
Retrieve operation of resource: address
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
QUERIER-ADDRESS - Retrieve
Retrieve operation of resource: querier-address
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SUBSCRIBER-ADDRESS - Retrieve
Retrieve operation of resource: subscriber-address
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SSM-MAP-DETAILS - Retrieve
Retrieve operation of resource: ssm-map-details
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ssm-map-detail": [
{
"response-pending": "boolean",
"query-interval": "integer",
"map-info": {
"source-counts": "integer",
"map-type": "integer",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
},
"expiration-time": "integer",
"sources": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"elapsed-time": "integer"
}
]
}
SSM-MAP-DETAIL - Retrieve
Retrieve operation of resource: ssm-map-detail
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"response-pending": "boolean",
"query-interval": "integer",
"map-info": {
"source-counts": "integer",
"map-type": "integer",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
},
"expiration-time": "integer",
"sources": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"elapsed-time": "integer"
}
MAP-INFO - Retrieve
Retrieve operation of resource: map-info
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"source-counts": "integer",
"map-type": "integer",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
GROUP-ADDRESS-XR - Retrieve
Retrieve operation of resource: group-address-xr
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SOURCES - Retrieve
Retrieve operation of resource: sources
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
INTERFACE-STATE-OFFS - Retrieve
Retrieve operation of resource: interface-state-offs
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-state-off": [
{
"las-ll-remove-update-count": "integer",
"las-ll-add-update-count": "integer",
"las-update-count": "integer",
"configurationvrf-set": "boolean",
"vrf-id": "integer",
"subscriber-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"vrf-state": "integer",
"last-member-query-interval": "integer",
"interface-name-xr": "string",
"is-las-registered": "boolean",
"group-leaves": "integer",
"is-router-enabled": "boolean",
"las-get-address-count": "integer",
"subscriber-mode": "integer",
"total-active-groups": "integer",
"configuration-mcast-vrf-set": "boolean",
"querier-uptime": "integer",
"proxy-interface": "string",
"is-subscriber": "boolean",
"mte-vrf-id": "integer",
"state": "string",
"time-since-last-query-in-seconds": "integer",
"location": "integer",
"subscriber-id": "string",
"is-ip-enabled": "boolean",
"router-uptime-in-seconds": "integer",
"parent-ifhandle": "string",
"query-interval": "integer",
"configuration-mcast-vrf-error": "boolean",
"is-identity-present": "boolean",
"query-timeout": "integer",
"query-maximum-response-time": "integer",
"querier-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"igmp-version": "integer",
"las-ll-registration-count": "integer",
"is-interface-up": "boolean",
"mte-tuple-count": "integer",
"is-las-request": "boolean",
"prefix-length": "integer",
"las-null-update-count": "integer",
"is-querier": "boolean",
"robustness": "integer",
"las-unregistration-count": "integer",
"is-im-state-registered": "boolean",
"mtu": "integer",
"is-configurationverify": "boolean",
"time-since-last-report-in-seconds": "integer",
"configurationvrf-error": "boolean",
"host-version": "integer",
"group-joins": "integer"
}
]
}
INTERFACE-STATE-OFF - Retrieve
Retrieve operation of resource: interface-state-off
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"las-ll-remove-update-count": "integer",
"las-ll-add-update-count": "integer",
"las-update-count": "integer",
"configurationvrf-set": "boolean",
"vrf-id": "integer",
"subscriber-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"vrf-state": "integer",
"last-member-query-interval": "integer",
"interface-name-xr": "string",
"is-las-registered": "boolean",
"group-leaves": "integer",
"is-router-enabled": "boolean",
"las-get-address-count": "integer",
"subscriber-mode": "integer",
"total-active-groups": "integer",
"configuration-mcast-vrf-set": "boolean",
"querier-uptime": "integer",
"proxy-interface": "string",
"is-subscriber": "boolean",
"mte-vrf-id": "integer",
"state": "string",
"time-since-last-query-in-seconds": "integer",
"location": "integer",
"subscriber-id": "string",
"is-ip-enabled": "boolean",
"router-uptime-in-seconds": "integer",
"parent-ifhandle": "string",
"query-interval": "integer",
"configuration-mcast-vrf-error": "boolean",
"is-identity-present": "boolean",
"query-timeout": "integer",
"query-maximum-response-time": "integer",
"querier-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"igmp-version": "integer",
"las-ll-registration-count": "integer",
"is-interface-up": "boolean",
"mte-tuple-count": "integer",
"is-las-request": "boolean",
"prefix-length": "integer",
"las-null-update-count": "integer",
"is-querier": "boolean",
"robustness": "integer",
"las-unregistration-count": "integer",
"is-im-state-registered": "boolean",
"mtu": "integer",
"is-configurationverify": "boolean",
"time-since-last-report-in-seconds": "integer",
"configurationvrf-error": "boolean",
"host-version": "integer",
"group-joins": "integer"
}
ADDRESS - Retrieve
Retrieve operation of resource: address
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
QUERIER-ADDRESS - Retrieve
Retrieve operation of resource: querier-address
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SUBSCRIBER-ADDRESS - Retrieve
Retrieve operation of resource: subscriber-address
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
IGMP - Retrieve
Retrieve operation of resource: igmp
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"active": {
"default-context": {
"interface-state-offs": {
"interface-state-off": [
{
"interface-name": "string",
"las-ll-remove-update-count": "integer",
"las-ll-add-update-count": "integer",
"las-update-count": "integer",
"configurationvrf-set": "boolean",
"vrf-id": "integer",
"subscriber-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"vrf-state": "integer",
"last-member-query-interval": "integer",
"interface-name-xr": "string",
"is-las-registered": "boolean",
"group-leaves": "integer",
"is-router-enabled": "boolean",
"las-get-address-count": "integer",
"subscriber-mode": "integer",
"total-active-groups": "integer",
"configuration-mcast-vrf-set": "boolean",
"querier-uptime": "integer",
"proxy-interface": "string",
"is-subscriber": "boolean",
"mte-vrf-id": "integer",
"state": "string",
"time-since-last-query-in-seconds": "integer",
"location": "integer",
"subscriber-id": "string",
"is-ip-enabled": "boolean",
"router-uptime-in-seconds": "integer",
"parent-ifhandle": "string",
"query-interval": "integer",
"configuration-mcast-vrf-error": "boolean",
"is-identity-present": "boolean",
"query-timeout": "integer",
"query-maximum-response-time": "integer",
"querier-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"igmp-version": "integer",
"las-ll-registration-count": "integer",
"is-interface-up": "boolean",
"mte-tuple-count": "integer",
"is-las-request": "boolean",
"prefix-length": "integer",
"las-null-update-count": "integer",
"is-querier": "boolean",
"robustness": "integer",
"las-unregistration-count": "integer",
"is-im-state-registered": "boolean",
"mtu": "integer",
"is-configurationverify": "boolean",
"time-since-last-report-in-seconds": "integer",
"configurationvrf-error": "boolean",
"host-version": "integer",
"group-joins": "integer"
}
]
}
}
}
}
STANDBY - Retrieve
Retrieve operation of resource: standby
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"default-context": {
"interface-state-offs": {
"interface-state-off": [
{
"interface-name": "string",
"las-ll-remove-update-count": "integer",
"las-ll-add-update-count": "integer",
"las-update-count": "integer",
"configurationvrf-set": "boolean",
"vrf-id": "integer",
"subscriber-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"vrf-state": "integer",
"last-member-query-interval": "integer",
"interface-name-xr": "string",
"is-las-registered": "boolean",
"group-leaves": "integer",
"is-router-enabled": "boolean",
"las-get-address-count": "integer",
"subscriber-mode": "integer",
"total-active-groups": "integer",
"configuration-mcast-vrf-set": "boolean",
"querier-uptime": "integer",
"proxy-interface": "string",
"is-subscriber": "boolean",
"mte-vrf-id": "integer",
"state": "string",
"time-since-last-query-in-seconds": "integer",
"location": "integer",
"subscriber-id": "string",
"is-ip-enabled": "boolean",
"router-uptime-in-seconds": "integer",
"parent-ifhandle": "string",
"query-interval": "integer",
"configuration-mcast-vrf-error": "boolean",
"is-identity-present": "boolean",
"query-timeout": "integer",
"query-maximum-response-time": "integer",
"querier-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"igmp-version": "integer",
"las-ll-registration-count": "integer",
"is-interface-up": "boolean",
"mte-tuple-count": "integer",
"is-las-request": "boolean",
"prefix-length": "integer",
"las-null-update-count": "integer",
"is-querier": "boolean",
"robustness": "integer",
"las-unregistration-count": "integer",
"is-im-state-registered": "boolean",
"mtu": "integer",
"is-configurationverify": "boolean",
"time-since-last-report-in-seconds": "integer",
"configurationvrf-error": "boolean",
"host-version": "integer",
"group-joins": "integer"
}
]
}
}
}
VRFS - Retrieve
Retrieve operation of resource: vrfs
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"vrf": [
{
"interface-state-offs": {
"interface-state-off": [
{
"interface-name": "string",
"las-ll-remove-update-count": "integer",
"las-ll-add-update-count": "integer",
"las-update-count": "integer",
"configurationvrf-set": "boolean",
"vrf-id": "integer",
"subscriber-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"vrf-state": "integer",
"last-member-query-interval": "integer",
"interface-name-xr": "string",
"is-las-registered": "boolean",
"group-leaves": "integer",
"is-router-enabled": "boolean",
"las-get-address-count": "integer",
"subscriber-mode": "integer",
"total-active-groups": "integer",
"configuration-mcast-vrf-set": "boolean",
"querier-uptime": "integer",
"proxy-interface": "string",
"is-subscriber": "boolean",
"mte-vrf-id": "integer",
"state": "string",
"time-since-last-query-in-seconds": "integer",
"location": "integer",
"subscriber-id": "string",
"is-ip-enabled": "boolean",
"router-uptime-in-seconds": "integer",
"parent-ifhandle": "string",
"query-interval": "integer",
"configuration-mcast-vrf-error": "boolean",
"is-identity-present": "boolean",
"query-timeout": "integer",
"query-maximum-response-time": "integer",
"querier-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"igmp-version": "integer",
"las-ll-registration-count": "integer",
"is-interface-up": "boolean",
"mte-tuple-count": "integer",
"is-las-request": "boolean",
"prefix-length": "integer",
"las-null-update-count": "integer",
"is-querier": "boolean",
"robustness": "integer",
"las-unregistration-count": "integer",
"is-im-state-registered": "boolean",
"mtu": "integer",
"is-configurationverify": "boolean",
"time-since-last-report-in-seconds": "integer",
"configurationvrf-error": "boolean",
"host-version": "integer",
"group-joins": "integer"
}
]
}
}
]
}
VRF - Retrieve
Retrieve operation of resource: vrf
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-state-offs": {
"interface-state-off": [
{
"interface-name": "string",
"las-ll-remove-update-count": "integer",
"las-ll-add-update-count": "integer",
"las-update-count": "integer",
"configurationvrf-set": "boolean",
"vrf-id": "integer",
"subscriber-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"vrf-state": "integer",
"last-member-query-interval": "integer",
"interface-name-xr": "string",
"is-las-registered": "boolean",
"group-leaves": "integer",
"is-router-enabled": "boolean",
"las-get-address-count": "integer",
"subscriber-mode": "integer",
"total-active-groups": "integer",
"configuration-mcast-vrf-set": "boolean",
"querier-uptime": "integer",
"proxy-interface": "string",
"is-subscriber": "boolean",
"mte-vrf-id": "integer",
"state": "string",
"time-since-last-query-in-seconds": "integer",
"location": "integer",
"subscriber-id": "string",
"is-ip-enabled": "boolean",
"router-uptime-in-seconds": "integer",
"parent-ifhandle": "string",
"query-interval": "integer",
"configuration-mcast-vrf-error": "boolean",
"is-identity-present": "boolean",
"query-timeout": "integer",
"query-maximum-response-time": "integer",
"querier-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"igmp-version": "integer",
"las-ll-registration-count": "integer",
"is-interface-up": "boolean",
"mte-tuple-count": "integer",
"is-las-request": "boolean",
"prefix-length": "integer",
"las-null-update-count": "integer",
"is-querier": "boolean",
"robustness": "integer",
"las-unregistration-count": "integer",
"is-im-state-registered": "boolean",
"mtu": "integer",
"is-configurationverify": "boolean",
"time-since-last-report-in-seconds": "integer",
"configurationvrf-error": "boolean",
"host-version": "integer",
"group-joins": "integer"
}
]
}
}
SUMMARY - Retrieve
Retrieve operation of resource: summary
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"group-count": "integer",
"disabled-interface-count": "integer",
"group-limit": "integer",
"supported-interfaces": "integer",
"robustness": "integer",
"is-disabled": "boolean",
"enabled-interface-count": "integer",
"node-low-memory": "boolean",
"unsupported-interfaces": "integer",
"tunnel-mte-config-count": "integer",
"interface": [
{
"group-count": "integer",
"parent-ifhandle": "string",
"router-uptime-in-seconds": "integer",
"interface-name": "string",
"group-limit": "integer",
"on-off": "boolean",
"time-since-last-report-in-seconds": "integer",
"time-since-last-query-in-seconds": "integer"
}
]
}
INTERFACE - Retrieve
Retrieve operation of resource: interface
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"group-count": "integer",
"parent-ifhandle": "string",
"router-uptime-in-seconds": "integer",
"interface-name": "string",
"group-limit": "integer",
"on-off": "boolean",
"time-since-last-report-in-seconds": "integer",
"time-since-last-query-in-seconds": "integer"
}
INTERFACE-STATE-ONS - Retrieve
Retrieve operation of resource: interface-state-ons
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-state-on": [
{
"las-ll-remove-update-count": "integer",
"las-ll-add-update-count": "integer",
"las-update-count": "integer",
"configurationvrf-set": "boolean",
"vrf-id": "integer",
"subscriber-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"vrf-state": "integer",
"last-member-query-interval": "integer",
"interface-name-xr": "string",
"is-las-registered": "boolean",
"group-leaves": "integer",
"is-router-enabled": "boolean",
"las-get-address-count": "integer",
"subscriber-mode": "integer",
"total-active-groups": "integer",
"configuration-mcast-vrf-set": "boolean",
"querier-uptime": "integer",
"proxy-interface": "string",
"is-subscriber": "boolean",
"mte-vrf-id": "integer",
"state": "string",
"time-since-last-query-in-seconds": "integer",
"location": "integer",
"subscriber-id": "string",
"is-ip-enabled": "boolean",
"router-uptime-in-seconds": "integer",
"parent-ifhandle": "string",
"query-interval": "integer",
"configuration-mcast-vrf-error": "boolean",
"is-identity-present": "boolean",
"query-timeout": "integer",
"query-maximum-response-time": "integer",
"querier-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"igmp-version": "integer",
"las-ll-registration-count": "integer",
"is-interface-up": "boolean",
"mte-tuple-count": "integer",
"is-las-request": "boolean",
"prefix-length": "integer",
"las-null-update-count": "integer",
"is-querier": "boolean",
"robustness": "integer",
"las-unregistration-count": "integer",
"is-im-state-registered": "boolean",
"mtu": "integer",
"is-configurationverify": "boolean",
"time-since-last-report-in-seconds": "integer",
"configurationvrf-error": "boolean",
"host-version": "integer",
"group-joins": "integer"
}
]
}
INTERFACE-STATE-ON - Retrieve
Retrieve operation of resource: interface-state-on
vrf-name
in path
string
ID of vrf-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"las-ll-remove-update-count": "integer",
"las-ll-add-update-count": "integer",
"las-update-count": "integer",
"configurationvrf-set": "boolean",
"vrf-id": "integer",
"subscriber-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"vrf-state": "integer",
"last-member-query-interval": "integer",
"interface-name-xr": "string",
"is-las-registered": "boolean",
"group-leaves": "integer",
"is-router-enabled": "boolean",
"las-get-address-count": "integer",
"subscriber-mode": "integer",
"total-active-groups": "integer",
"configuration-mcast-vrf-set": "boolean",
"querier-uptime": "integer",
"proxy-interface": "string",
"is-subscriber": "boolean",
"mte-vrf-id": "integer",
"state": "string",
"time-since-last-query-in-seconds": "integer",
"location": "integer",
"subscriber-id": "string",
"is-ip-enabled": "boolean",
"router-uptime-in-seconds": "integer",
"parent-ifhandle": "string",
"query-interval": "integer",
"configuration-mcast-vrf-error": "boolean",
"is-identity-present": "boolean",
"query-timeout": "integer",
"query-maximum-response-time": "integer",
"querier-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"igmp-version": "integer",
"las-ll-registration-count": "integer",
"is-interface-up": "boolean",
"mte-tuple-count": "integer",
"is-las-request": "boolean",
"prefix-length": "integer",
"las-null-update-count": "integer",
"is-querier": "boolean",
"robustness": "integer",
"las-unregistration-count": "integer",
"is-im-state-registered": "boolean",
"mtu": "integer",
"is-configurationverify": "boolean",
"time-since-last-report-in-seconds": "integer",
"configurationvrf-error": "boolean",
"host-version": "integer",
"group-joins": "integer"
}
ADDRESS - Retrieve
Retrieve operation of resource: address
vrf-name
in path
string
ID of vrf-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
QUERIER-ADDRESS - Retrieve
Retrieve operation of resource: querier-address
vrf-name
in path
string
ID of vrf-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SUBSCRIBER-ADDRESS - Retrieve
Retrieve operation of resource: subscriber-address
vrf-name
in path
string
ID of vrf-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
DETAIL-GROUPS - Retrieve
Retrieve operation of resource: detail-groups
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"detail-group": [
{
"source": [
{
"uptime": "integer",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"expiration-time": "string",
"is-local": "boolean",
"is-forward": "boolean",
"is-added": "boolean",
"flags": "string",
"is-remote": "boolean",
"is-we-report": "boolean"
}
],
"is-router-exclude-mode": "boolean",
"group-info": {
"uptime": "integer",
"older-host-version1-timer": "integer",
"row-status": "string",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-added": "boolean",
"older-host-version2-timer": "integer",
"last-reporter": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"expiration-time": "string",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-suppressed": "boolean",
"is-self-join": "boolean",
"is-low-memory": "boolean",
"interface-name-xr": "string",
"router-filter-mode": "integer",
"explicit-tracking-enabled": "boolean"
},
"is-host-exclude-mode": "boolean"
}
]
}
DETAIL-GROUP - Retrieve
Retrieve operation of resource: detail-group
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"source": [
{
"uptime": "integer",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"expiration-time": "string",
"is-local": "boolean",
"is-forward": "boolean",
"is-added": "boolean",
"flags": "string",
"is-remote": "boolean",
"is-we-report": "boolean"
}
],
"is-router-exclude-mode": "boolean",
"group-info": {
"uptime": "integer",
"older-host-version1-timer": "integer",
"row-status": "string",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-added": "boolean",
"older-host-version2-timer": "integer",
"last-reporter": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"expiration-time": "string",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-suppressed": "boolean",
"is-self-join": "boolean",
"is-low-memory": "boolean",
"interface-name-xr": "string",
"router-filter-mode": "integer",
"explicit-tracking-enabled": "boolean"
},
"is-host-exclude-mode": "boolean"
}
GROUP-INFO - Retrieve
Retrieve operation of resource: group-info
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"uptime": "integer",
"older-host-version1-timer": "integer",
"row-status": "string",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-added": "boolean",
"older-host-version2-timer": "integer",
"last-reporter": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"expiration-time": "string",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-suppressed": "boolean",
"is-self-join": "boolean",
"is-low-memory": "boolean",
"interface-name-xr": "string",
"router-filter-mode": "integer",
"explicit-tracking-enabled": "boolean"
}
GROUP-ADDRESS-XR - Retrieve
Retrieve operation of resource: group-address-xr
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
LAST-REPORTER - Retrieve
Retrieve operation of resource: last-reporter
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SOURCE-ADDRESS - Retrieve
Retrieve operation of resource: source-address
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SOURCE - Retrieve
Retrieve operation of resource: source
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"uptime": "integer",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"expiration-time": "string",
"is-local": "boolean",
"is-forward": "boolean",
"is-added": "boolean",
"flags": "string",
"is-remote": "boolean",
"is-we-report": "boolean"
}
SOURCE-ADDRESS - Retrieve
Retrieve operation of resource: source-address
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
NON-ACTIVE-GROUPS - Retrieve
Retrieve operation of resource: non-active-groups
vrf-name
in path
string
ID of vrf-name
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"non-active-groups": [
{
"interface": "string",
"group-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"reason-for-non-activity": "string",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
}
NON-ACTIVE-GROUPS - Retrieve
Retrieve operation of resource: non-active-groups
vrf-name
in path
string
ID of vrf-name
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface": "string",
"group-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"reason-for-non-activity": "string",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
GROUP-ADDRESS - Retrieve
Retrieve operation of resource: group-address
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SOURCE-ADDRESS - Retrieve
Retrieve operation of resource: source-address
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SSM-MAPS - Retrieve
Retrieve operation of resource: ssm-maps
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ssm-map": [
{
"source-counts": "integer",
"map-type": "integer",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
}
SSM-MAP - Retrieve
Retrieve operation of resource: ssm-map
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"source-counts": "integer",
"map-type": "integer",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
GROUP-ADDRESS-XR - Retrieve
Retrieve operation of resource: group-address-xr
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
EXPLICIT-GROUPS - Retrieve
Retrieve operation of resource: explicit-groups
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"explicit-group": [
{
"exclude-hosts": "integer",
"host": [
{
"uptime": "integer",
"source-address": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"is-exclude": "boolean",
"expiration-time": "integer",
"source-count": "integer",
"address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
],
"include-hosts": "integer",
"group-info": {
"uptime": "integer",
"older-host-version1-timer": "integer",
"row-status": "string",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-added": "boolean",
"older-host-version2-timer": "integer",
"last-reporter": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"expiration-time": "string",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-suppressed": "boolean",
"is-self-join": "boolean",
"is-low-memory": "boolean",
"interface-name-xr": "string",
"router-filter-mode": "integer",
"explicit-tracking-enabled": "boolean"
}
}
]
}
EXPLICIT-GROUP - Retrieve
Retrieve operation of resource: explicit-group
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"exclude-hosts": "integer",
"host": [
{
"uptime": "integer",
"source-address": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"is-exclude": "boolean",
"expiration-time": "integer",
"source-count": "integer",
"address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
],
"include-hosts": "integer",
"group-info": {
"uptime": "integer",
"older-host-version1-timer": "integer",
"row-status": "string",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-added": "boolean",
"older-host-version2-timer": "integer",
"last-reporter": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"expiration-time": "string",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-suppressed": "boolean",
"is-self-join": "boolean",
"is-low-memory": "boolean",
"interface-name-xr": "string",
"router-filter-mode": "integer",
"explicit-tracking-enabled": "boolean"
}
}
GROUP-INFO - Retrieve
Retrieve operation of resource: group-info
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"uptime": "integer",
"older-host-version1-timer": "integer",
"row-status": "string",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-added": "boolean",
"older-host-version2-timer": "integer",
"last-reporter": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"expiration-time": "string",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-suppressed": "boolean",
"is-self-join": "boolean",
"is-low-memory": "boolean",
"interface-name-xr": "string",
"router-filter-mode": "integer",
"explicit-tracking-enabled": "boolean"
}
GROUP-ADDRESS-XR - Retrieve
Retrieve operation of resource: group-address-xr
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
LAST-REPORTER - Retrieve
Retrieve operation of resource: last-reporter
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SOURCE-ADDRESS - Retrieve
Retrieve operation of resource: source-address
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
HOST - Retrieve
Retrieve operation of resource: host
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"uptime": "integer",
"source-address": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"is-exclude": "boolean",
"expiration-time": "integer",
"source-count": "integer",
"address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
ADDRESS - Retrieve
Retrieve operation of resource: address
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SOURCE-ADDRESS - Retrieve
Retrieve operation of resource: source-address
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
INTERFACE-TABLE - Retrieve
Retrieve operation of resource: interface-table
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface": [
{
"interface-name": "string",
"las-ll-remove-update-count": "integer",
"las-ll-add-update-count": "integer",
"las-update-count": "integer",
"configurationvrf-set": "boolean",
"vrf-id": "integer",
"subscriber-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"vrf-state": "integer",
"last-member-query-interval": "integer",
"interface-name-xr": "string",
"is-las-registered": "boolean",
"group-leaves": "integer",
"is-router-enabled": "boolean",
"las-get-address-count": "integer",
"subscriber-mode": "integer",
"total-active-groups": "integer",
"configuration-mcast-vrf-set": "boolean",
"querier-uptime": "integer",
"proxy-interface": "string",
"is-subscriber": "boolean",
"mte-vrf-id": "integer",
"state": "string",
"time-since-last-query-in-seconds": "integer",
"location": "integer",
"subscriber-id": "string",
"is-ip-enabled": "boolean",
"router-uptime-in-seconds": "integer",
"parent-ifhandle": "string",
"query-interval": "integer",
"configuration-mcast-vrf-error": "boolean",
"is-identity-present": "boolean",
"query-timeout": "integer",
"query-maximum-response-time": "integer",
"querier-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"igmp-version": "integer",
"las-ll-registration-count": "integer",
"is-interface-up": "boolean",
"mte-tuple-count": "integer",
"is-las-request": "boolean",
"prefix-length": "integer",
"las-null-update-count": "integer",
"is-querier": "boolean",
"robustness": "integer",
"las-unregistration-count": "integer",
"is-im-state-registered": "boolean",
"mtu": "integer",
"is-configurationverify": "boolean",
"time-since-last-report-in-seconds": "integer",
"configurationvrf-error": "boolean",
"host-version": "integer",
"group-joins": "integer"
}
]
}
INTERFACE - Retrieve
Retrieve operation of resource: interface
vrf-name
in path
string
ID of vrf-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"las-ll-remove-update-count": "integer",
"las-ll-add-update-count": "integer",
"las-update-count": "integer",
"configurationvrf-set": "boolean",
"vrf-id": "integer",
"subscriber-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"vrf-state": "integer",
"last-member-query-interval": "integer",
"interface-name-xr": "string",
"is-las-registered": "boolean",
"group-leaves": "integer",
"is-router-enabled": "boolean",
"las-get-address-count": "integer",
"subscriber-mode": "integer",
"total-active-groups": "integer",
"configuration-mcast-vrf-set": "boolean",
"querier-uptime": "integer",
"proxy-interface": "string",
"is-subscriber": "boolean",
"mte-vrf-id": "integer",
"state": "string",
"time-since-last-query-in-seconds": "integer",
"location": "integer",
"subscriber-id": "string",
"is-ip-enabled": "boolean",
"router-uptime-in-seconds": "integer",
"parent-ifhandle": "string",
"query-interval": "integer",
"configuration-mcast-vrf-error": "boolean",
"is-identity-present": "boolean",
"query-timeout": "integer",
"query-maximum-response-time": "integer",
"querier-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"igmp-version": "integer",
"las-ll-registration-count": "integer",
"is-interface-up": "boolean",
"mte-tuple-count": "integer",
"is-las-request": "boolean",
"prefix-length": "integer",
"las-null-update-count": "integer",
"is-querier": "boolean",
"robustness": "integer",
"las-unregistration-count": "integer",
"is-im-state-registered": "boolean",
"mtu": "integer",
"is-configurationverify": "boolean",
"time-since-last-report-in-seconds": "integer",
"configurationvrf-error": "boolean",
"host-version": "integer",
"group-joins": "integer"
}
ADDRESS - Retrieve
Retrieve operation of resource: address
vrf-name
in path
string
ID of vrf-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
QUERIER-ADDRESS - Retrieve
Retrieve operation of resource: querier-address
vrf-name
in path
string
ID of vrf-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SUBSCRIBER-ADDRESS - Retrieve
Retrieve operation of resource: subscriber-address
vrf-name
in path
string
ID of vrf-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
INTERFACE-UNICAST-QOS-ADJUSTS - Retrieve
Retrieve operation of resource: interface-unicast-qos-adjusts
vrf-name
in path
string
ID of vrf-name
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-unicast-qos-adjust": [
{
"is-virtual-access": "boolean",
"rate": "integer",
"rate-increments": "integer",
"rate-decrements": "integer",
"update": [
{
"is-add": "boolean",
"group-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"received-time": "integer",
"weight": "integer",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
}
]
}
INTERFACE-UNICAST-QOS-ADJUST - Retrieve
Retrieve operation of resource: interface-unicast-qos-adjust
vrf-name
in path
string
ID of vrf-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-virtual-access": "boolean",
"rate": "integer",
"rate-increments": "integer",
"rate-decrements": "integer",
"update": [
{
"is-add": "boolean",
"group-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"received-time": "integer",
"weight": "integer",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
}
UPDATE - Retrieve
Retrieve operation of resource: update
vrf-name
in path
string
ID of vrf-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-add": "boolean",
"group-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"received-time": "integer",
"weight": "integer",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
SOURCE-ADDRESS - Retrieve
Retrieve operation of resource: source-address
vrf-name
in path
string
ID of vrf-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
GROUP-ADDRESS - Retrieve
Retrieve operation of resource: group-address
vrf-name
in path
string
ID of vrf-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
RANGES - Retrieve
Retrieve operation of resource: ranges
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"range": [
{
"is-stale": "boolean",
"protocol": "string",
"prefix-length": "integer",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
}
RANGE - Retrieve
Retrieve operation of resource: range
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-stale": "boolean",
"protocol": "string",
"prefix-length": "integer",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
GROUP-ADDRESS-XR - Retrieve
Retrieve operation of resource: group-address-xr
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
IFRS-INTERFACES - Retrieve
Retrieve operation of resource: ifrs-interfaces
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ifrs-interface": [
{
"join-group-count": "integer",
"igmp-interface-entry": {
"las-ll-remove-update-count": "integer",
"las-ll-add-update-count": "integer",
"las-update-count": "integer",
"configurationvrf-set": "boolean",
"vrf-id": "integer",
"subscriber-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"vrf-state": "integer",
"last-member-query-interval": "integer",
"interface-name-xr": "string",
"is-las-registered": "boolean",
"group-leaves": "integer",
"is-router-enabled": "boolean",
"las-get-address-count": "integer",
"subscriber-mode": "integer",
"total-active-groups": "integer",
"configuration-mcast-vrf-set": "boolean",
"querier-uptime": "integer",
"proxy-interface": "string",
"is-subscriber": "boolean",
"mte-vrf-id": "integer",
"state": "string",
"time-since-last-query-in-seconds": "integer",
"location": "integer",
"subscriber-id": "string",
"is-ip-enabled": "boolean",
"router-uptime-in-seconds": "integer",
"parent-ifhandle": "string",
"query-interval": "integer",
"configuration-mcast-vrf-error": "boolean",
"is-identity-present": "boolean",
"query-timeout": "integer",
"query-maximum-response-time": "integer",
"querier-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"igmp-version": "integer",
"las-ll-registration-count": "integer",
"is-interface-up": "boolean",
"mte-tuple-count": "integer",
"is-las-request": "boolean",
"prefix-length": "integer",
"las-null-update-count": "integer",
"is-querier": "boolean",
"robustness": "integer",
"las-unregistration-count": "integer",
"is-im-state-registered": "boolean",
"mtu": "integer",
"is-configurationverify": "boolean",
"time-since-last-report-in-seconds": "integer",
"configurationvrf-error": "boolean",
"host-version": "integer",
"group-joins": "integer"
}
}
]
}
IFRS-INTERFACE - Retrieve
Retrieve operation of resource: ifrs-interface
vrf-name
in path
string
ID of vrf-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"join-group-count": "integer",
"igmp-interface-entry": {
"las-ll-remove-update-count": "integer",
"las-ll-add-update-count": "integer",
"las-update-count": "integer",
"configurationvrf-set": "boolean",
"vrf-id": "integer",
"subscriber-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"vrf-state": "integer",
"last-member-query-interval": "integer",
"interface-name-xr": "string",
"is-las-registered": "boolean",
"group-leaves": "integer",
"is-router-enabled": "boolean",
"las-get-address-count": "integer",
"subscriber-mode": "integer",
"total-active-groups": "integer",
"configuration-mcast-vrf-set": "boolean",
"querier-uptime": "integer",
"proxy-interface": "string",
"is-subscriber": "boolean",
"mte-vrf-id": "integer",
"state": "string",
"time-since-last-query-in-seconds": "integer",
"location": "integer",
"subscriber-id": "string",
"is-ip-enabled": "boolean",
"router-uptime-in-seconds": "integer",
"parent-ifhandle": "string",
"query-interval": "integer",
"configuration-mcast-vrf-error": "boolean",
"is-identity-present": "boolean",
"query-timeout": "integer",
"query-maximum-response-time": "integer",
"querier-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"igmp-version": "integer",
"las-ll-registration-count": "integer",
"is-interface-up": "boolean",
"mte-tuple-count": "integer",
"is-las-request": "boolean",
"prefix-length": "integer",
"las-null-update-count": "integer",
"is-querier": "boolean",
"robustness": "integer",
"las-unregistration-count": "integer",
"is-im-state-registered": "boolean",
"mtu": "integer",
"is-configurationverify": "boolean",
"time-since-last-report-in-seconds": "integer",
"configurationvrf-error": "boolean",
"host-version": "integer",
"group-joins": "integer"
}
}
IGMP-INTERFACE-ENTRY - Retrieve
Retrieve operation of resource: igmp-interface-entry
vrf-name
in path
string
ID of vrf-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"las-ll-remove-update-count": "integer",
"las-ll-add-update-count": "integer",
"las-update-count": "integer",
"configurationvrf-set": "boolean",
"vrf-id": "integer",
"subscriber-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"vrf-state": "integer",
"last-member-query-interval": "integer",
"interface-name-xr": "string",
"is-las-registered": "boolean",
"group-leaves": "integer",
"is-router-enabled": "boolean",
"las-get-address-count": "integer",
"subscriber-mode": "integer",
"total-active-groups": "integer",
"configuration-mcast-vrf-set": "boolean",
"querier-uptime": "integer",
"proxy-interface": "string",
"is-subscriber": "boolean",
"mte-vrf-id": "integer",
"state": "string",
"time-since-last-query-in-seconds": "integer",
"location": "integer",
"subscriber-id": "string",
"is-ip-enabled": "boolean",
"router-uptime-in-seconds": "integer",
"parent-ifhandle": "string",
"query-interval": "integer",
"configuration-mcast-vrf-error": "boolean",
"is-identity-present": "boolean",
"query-timeout": "integer",
"query-maximum-response-time": "integer",
"querier-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"igmp-version": "integer",
"las-ll-registration-count": "integer",
"is-interface-up": "boolean",
"mte-tuple-count": "integer",
"is-las-request": "boolean",
"prefix-length": "integer",
"las-null-update-count": "integer",
"is-querier": "boolean",
"robustness": "integer",
"las-unregistration-count": "integer",
"is-im-state-registered": "boolean",
"mtu": "integer",
"is-configurationverify": "boolean",
"time-since-last-report-in-seconds": "integer",
"configurationvrf-error": "boolean",
"host-version": "integer",
"group-joins": "integer"
}
ADDRESS - Retrieve
Retrieve operation of resource: address
vrf-name
in path
string
ID of vrf-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
QUERIER-ADDRESS - Retrieve
Retrieve operation of resource: querier-address
vrf-name
in path
string
ID of vrf-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SUBSCRIBER-ADDRESS - Retrieve
Retrieve operation of resource: subscriber-address
vrf-name
in path
string
ID of vrf-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
TRAFFIC-COUNTERS - Retrieve
Retrieve operation of resource: traffic-counters
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"checksum-errors": "integer",
"auxillary-data-length-errors": "integer",
"input-mtrace": "integer",
"socket-errors": "integer",
"packet-manager-input-errors": "integer",
"packets-out": "integer",
"input-no-idb": "integer",
"output-no-parent-interface-handle": "integer",
"receive-socket-errors": "integer",
"output-leaves": "integer",
"no-socket-connection": "integer",
"bad-scope-errors": "integer",
"input-leaves": "integer",
"invalid-source-address-errors": "integer",
"get-packet-failure": "integer",
"input-dvmrp": "integer",
"miscellaneous-errors": "integer",
"elapsed-time": "integer",
"input-no-platform-support-mtrace": "integer",
"input-queries": "integer",
"output-pim": "integer",
"input-disabled-idb": "integer",
"packet-manager-output-errors": "integer",
"format-errors": "integer",
"packets-in": "integer",
"input-no-vrf-mtrace": "integer",
"input-no-assigned-vrf-id": "integer",
"input-reports": "integer",
"input-pim": "integer",
"input-martian-address": "integer",
"output-queries": "integer",
"input-no-vrf-in-idb": "integer",
"output-mtrace": "integer",
"output-reports": "integer",
"output-dvmrp": "integer"
}
GROUPS - Retrieve
Retrieve operation of resource: groups
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"group": [
{
"uptime": "integer",
"older-host-version1-timer": "integer",
"row-status": "string",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-added": "boolean",
"older-host-version2-timer": "integer",
"last-reporter": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"expiration-time": "string",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-suppressed": "boolean",
"is-self-join": "boolean",
"is-low-memory": "boolean",
"interface-name-xr": "string",
"router-filter-mode": "integer",
"explicit-tracking-enabled": "boolean"
}
]
}
GROUP - Retrieve
Retrieve operation of resource: group
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"uptime": "integer",
"older-host-version1-timer": "integer",
"row-status": "string",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-added": "boolean",
"older-host-version2-timer": "integer",
"last-reporter": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"expiration-time": "string",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-suppressed": "boolean",
"is-self-join": "boolean",
"is-low-memory": "boolean",
"interface-name-xr": "string",
"router-filter-mode": "integer",
"explicit-tracking-enabled": "boolean"
}
GROUP-ADDRESS-XR - Retrieve
Retrieve operation of resource: group-address-xr
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
LAST-REPORTER - Retrieve
Retrieve operation of resource: last-reporter
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SOURCE-ADDRESS - Retrieve
Retrieve operation of resource: source-address
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
GROUP-SUMMARY - Retrieve
Retrieve operation of resource: group-summary
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"group-count": "integer",
"groutes": "integer",
"sg-routes": "integer",
"is-low-memory": "boolean"
}
IFRS-INTERFACE-SUMMARY - Retrieve
Retrieve operation of resource: ifrs-interface-summary
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-count": "integer",
"configuration-count": "integer"
}
GLOBAL-INTERFACE-TABLE - Retrieve
Retrieve operation of resource: global-interface-table
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface": [
{
"interface-name": "string",
"las-ll-remove-update-count": "integer",
"las-ll-add-update-count": "integer",
"las-update-count": "integer",
"configurationvrf-set": "boolean",
"vrf-id": "integer",
"subscriber-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"vrf-state": "integer",
"last-member-query-interval": "integer",
"interface-name-xr": "string",
"is-las-registered": "boolean",
"group-leaves": "integer",
"is-router-enabled": "boolean",
"las-get-address-count": "integer",
"subscriber-mode": "integer",
"total-active-groups": "integer",
"configuration-mcast-vrf-set": "boolean",
"querier-uptime": "integer",
"proxy-interface": "string",
"is-subscriber": "boolean",
"mte-vrf-id": "integer",
"state": "string",
"time-since-last-query-in-seconds": "integer",
"location": "integer",
"subscriber-id": "string",
"is-ip-enabled": "boolean",
"router-uptime-in-seconds": "integer",
"parent-ifhandle": "string",
"query-interval": "integer",
"configuration-mcast-vrf-error": "boolean",
"is-identity-present": "boolean",
"query-timeout": "integer",
"query-maximum-response-time": "integer",
"querier-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"igmp-version": "integer",
"las-ll-registration-count": "integer",
"is-interface-up": "boolean",
"mte-tuple-count": "integer",
"is-las-request": "boolean",
"prefix-length": "integer",
"las-null-update-count": "integer",
"is-querier": "boolean",
"robustness": "integer",
"las-unregistration-count": "integer",
"is-im-state-registered": "boolean",
"mtu": "integer",
"is-configurationverify": "boolean",
"time-since-last-report-in-seconds": "integer",
"configurationvrf-error": "boolean",
"host-version": "integer",
"group-joins": "integer"
}
]
}
INTERFACE - Retrieve
Retrieve operation of resource: interface
vrf-name
in path
string
ID of vrf-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"las-ll-remove-update-count": "integer",
"las-ll-add-update-count": "integer",
"las-update-count": "integer",
"configurationvrf-set": "boolean",
"vrf-id": "integer",
"subscriber-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"vrf-state": "integer",
"last-member-query-interval": "integer",
"interface-name-xr": "string",
"is-las-registered": "boolean",
"group-leaves": "integer",
"is-router-enabled": "boolean",
"las-get-address-count": "integer",
"subscriber-mode": "integer",
"total-active-groups": "integer",
"configuration-mcast-vrf-set": "boolean",
"querier-uptime": "integer",
"proxy-interface": "string",
"is-subscriber": "boolean",
"mte-vrf-id": "integer",
"state": "string",
"time-since-last-query-in-seconds": "integer",
"location": "integer",
"subscriber-id": "string",
"is-ip-enabled": "boolean",
"router-uptime-in-seconds": "integer",
"parent-ifhandle": "string",
"query-interval": "integer",
"configuration-mcast-vrf-error": "boolean",
"is-identity-present": "boolean",
"query-timeout": "integer",
"query-maximum-response-time": "integer",
"querier-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"igmp-version": "integer",
"las-ll-registration-count": "integer",
"is-interface-up": "boolean",
"mte-tuple-count": "integer",
"is-las-request": "boolean",
"prefix-length": "integer",
"las-null-update-count": "integer",
"is-querier": "boolean",
"robustness": "integer",
"las-unregistration-count": "integer",
"is-im-state-registered": "boolean",
"mtu": "integer",
"is-configurationverify": "boolean",
"time-since-last-report-in-seconds": "integer",
"configurationvrf-error": "boolean",
"host-version": "integer",
"group-joins": "integer"
}
ADDRESS - Retrieve
Retrieve operation of resource: address
vrf-name
in path
string
ID of vrf-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
QUERIER-ADDRESS - Retrieve
Retrieve operation of resource: querier-address
vrf-name
in path
string
ID of vrf-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SUBSCRIBER-ADDRESS - Retrieve
Retrieve operation of resource: subscriber-address
vrf-name
in path
string
ID of vrf-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SSM-MAP-DETAILS - Retrieve
Retrieve operation of resource: ssm-map-details
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ssm-map-detail": [
{
"response-pending": "boolean",
"query-interval": "integer",
"map-info": {
"source-counts": "integer",
"map-type": "integer",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
},
"expiration-time": "integer",
"sources": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"elapsed-time": "integer"
}
]
}
SSM-MAP-DETAIL - Retrieve
Retrieve operation of resource: ssm-map-detail
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"response-pending": "boolean",
"query-interval": "integer",
"map-info": {
"source-counts": "integer",
"map-type": "integer",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
},
"expiration-time": "integer",
"sources": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"elapsed-time": "integer"
}
MAP-INFO - Retrieve
Retrieve operation of resource: map-info
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"source-counts": "integer",
"map-type": "integer",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
GROUP-ADDRESS-XR - Retrieve
Retrieve operation of resource: group-address-xr
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SOURCES - Retrieve
Retrieve operation of resource: sources
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
INTERFACE-STATE-OFFS - Retrieve
Retrieve operation of resource: interface-state-offs
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-state-off": [
{
"las-ll-remove-update-count": "integer",
"las-ll-add-update-count": "integer",
"las-update-count": "integer",
"configurationvrf-set": "boolean",
"vrf-id": "integer",
"subscriber-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"vrf-state": "integer",
"last-member-query-interval": "integer",
"interface-name-xr": "string",
"is-las-registered": "boolean",
"group-leaves": "integer",
"is-router-enabled": "boolean",
"las-get-address-count": "integer",
"subscriber-mode": "integer",
"total-active-groups": "integer",
"configuration-mcast-vrf-set": "boolean",
"querier-uptime": "integer",
"proxy-interface": "string",
"is-subscriber": "boolean",
"mte-vrf-id": "integer",
"state": "string",
"time-since-last-query-in-seconds": "integer",
"location": "integer",
"subscriber-id": "string",
"is-ip-enabled": "boolean",
"router-uptime-in-seconds": "integer",
"parent-ifhandle": "string",
"query-interval": "integer",
"configuration-mcast-vrf-error": "boolean",
"is-identity-present": "boolean",
"query-timeout": "integer",
"query-maximum-response-time": "integer",
"querier-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"igmp-version": "integer",
"las-ll-registration-count": "integer",
"is-interface-up": "boolean",
"mte-tuple-count": "integer",
"is-las-request": "boolean",
"prefix-length": "integer",
"las-null-update-count": "integer",
"is-querier": "boolean",
"robustness": "integer",
"las-unregistration-count": "integer",
"is-im-state-registered": "boolean",
"mtu": "integer",
"is-configurationverify": "boolean",
"time-since-last-report-in-seconds": "integer",
"configurationvrf-error": "boolean",
"host-version": "integer",
"group-joins": "integer"
}
]
}
INTERFACE-STATE-OFF - Retrieve
Retrieve operation of resource: interface-state-off
vrf-name
in path
string
ID of vrf-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"las-ll-remove-update-count": "integer",
"las-ll-add-update-count": "integer",
"las-update-count": "integer",
"configurationvrf-set": "boolean",
"vrf-id": "integer",
"subscriber-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"vrf-state": "integer",
"last-member-query-interval": "integer",
"interface-name-xr": "string",
"is-las-registered": "boolean",
"group-leaves": "integer",
"is-router-enabled": "boolean",
"las-get-address-count": "integer",
"subscriber-mode": "integer",
"total-active-groups": "integer",
"configuration-mcast-vrf-set": "boolean",
"querier-uptime": "integer",
"proxy-interface": "string",
"is-subscriber": "boolean",
"mte-vrf-id": "integer",
"state": "string",
"time-since-last-query-in-seconds": "integer",
"location": "integer",
"subscriber-id": "string",
"is-ip-enabled": "boolean",
"router-uptime-in-seconds": "integer",
"parent-ifhandle": "string",
"query-interval": "integer",
"configuration-mcast-vrf-error": "boolean",
"is-identity-present": "boolean",
"query-timeout": "integer",
"query-maximum-response-time": "integer",
"querier-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"igmp-version": "integer",
"las-ll-registration-count": "integer",
"is-interface-up": "boolean",
"mte-tuple-count": "integer",
"is-las-request": "boolean",
"prefix-length": "integer",
"las-null-update-count": "integer",
"is-querier": "boolean",
"robustness": "integer",
"las-unregistration-count": "integer",
"is-im-state-registered": "boolean",
"mtu": "integer",
"is-configurationverify": "boolean",
"time-since-last-report-in-seconds": "integer",
"configurationvrf-error": "boolean",
"host-version": "integer",
"group-joins": "integer"
}
ADDRESS - Retrieve
Retrieve operation of resource: address
vrf-name
in path
string
ID of vrf-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
QUERIER-ADDRESS - Retrieve
Retrieve operation of resource: querier-address
vrf-name
in path
string
ID of vrf-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SUBSCRIBER-ADDRESS - Retrieve
Retrieve operation of resource: subscriber-address
vrf-name
in path
string
ID of vrf-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
PROCESS - Retrieve
Retrieve operation of resource: process
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"amt-gateways": {
"amt-gateway": [
{
"amt-nonce": "integer",
"amtgw": "string",
"mem-upd-in": "integer",
"key-len": "integer",
"mem-upd-out": "integer",
"amtnh": "integer",
"amt-port": "integer",
"idb": "integer"
}
]
},
"unicast-qos-adjust-stats": {
"is-qos-s-sweeped": "boolean",
"batches": "integer",
"send-errors": "integer",
"last-download-time": "integer",
"sent-resync-bulks": "integer",
"is-resync-required": "boolean",
"queues": "integer",
"is-resync-start-sent": "boolean",
"send-partial-errors": "integer",
"last-sweep-time": "integer",
"send-success": "integer",
"is-resync-received": "boolean",
"add-to-batches": "integer",
"received-resync-requests": "integer",
"send-comm-errors": "integer",
"delete-to-batches": "integer"
},
"amt-summary": {
"gateway-count": "integer",
"prefix-length": "integer",
"anycast-prefix": "string",
"query-interval": "integer",
"relay-address": "string",
"tos": "integer",
"mtu": "integer",
"tunnel-count": "integer",
"tunnel-configured-maximum": "integer",
"ttl": "integer",
"is-acl-configured": "boolean",
"max-gateway": "integer",
"is-gateway-simulation": "boolean",
"is-ou-of-resource": "boolean"
},
"nsf": {
"last-nsf-off": "string",
"last-icd-notif-recv-min": "string",
"multicast-nsf-time-left": "integer",
"is-multicast-nsf-active": "boolean",
"last-icd-notif-recv": "string",
"multicast-nsf-timeout": "integer",
"respawn-count": "integer",
"last-nsf-on-min": "string",
"last-nsf-on": "string",
"last-nsf-off-min": "string"
},
"bvi-statistics": {
"tx-unknown-mrouter-msg": "integer",
"send-blocks": "integer",
"tx-protocol-buffers": "integer",
"rx-ipc-close-notif": "integer",
"rx-ipc-publish-notif": "integer",
"wtx-msg-proto-sent": "integer",
"rx-igmp-packet-success": "integer",
"rx-ipc-open-notif": "integer",
"rx-sweep-mrouter-msg": "integer",
"rx-ipc-lwm-notif": "integer",
"wtx-msg-drop-nomem": "integer",
"rx-delete-mrouter-msg": "integer",
"wtx-msg-freed": "integer",
"rx-ipc-q-full-notif": "integer",
"receive-buffers": "integer",
"rx-add-mrouter-msg": "integer",
"tx-add-mrouter-msg": "integer",
"rx-ipc-input-wait-notif": "integer",
"tx-sweep-mrouter-msg": "integer",
"tx-unknown-buffers": "integer",
"rx-ipc-send-status-notif": "integer",
"rx-ipc-output-notif": "integer",
"wtx-msg-drop-dc": "integer",
"null-buffer-handles": "integer",
"tx-delete-mrouter-msg": "integer",
"rx-ipc-error-notif": "integer",
"rx-unknown-mrouter-msg": "integer",
"release-buffers": "integer",
"release-fail-buffers": "integer",
"tx-buffer-errors": "integer",
"tx-mrouter-buffers": "integer",
"tx-buffers": "integer",
"wtx-msg-recvd": "integer",
"wtx-msg-sent": "integer",
"rx-ipc-connect-notif": "integer"
},
"nsr": {
"collab-conv-done": "boolean"
}
}
AMT-SUMMARY - Retrieve
Retrieve operation of resource: amt-summary
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"gateway-count": "integer",
"prefix-length": "integer",
"anycast-prefix": "string",
"query-interval": "integer",
"relay-address": "string",
"tos": "integer",
"mtu": "integer",
"tunnel-count": "integer",
"tunnel-configured-maximum": "integer",
"ttl": "integer",
"is-acl-configured": "boolean",
"max-gateway": "integer",
"is-gateway-simulation": "boolean",
"is-ou-of-resource": "boolean"
}
NSR - Retrieve
Retrieve operation of resource: nsr
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"collab-conv-done": "boolean",
"rmf-notification-done": "boolean",
"last-rmf-not-ready": "integer",
"count-proc-connection-dn": "integer",
"count-rmf-ready": "integer",
"state": "integer",
"count-proc-connection-up": "integer",
"last-proc": "integer",
"count-rmf-not-ready": "integer",
"last-proc-connection-up": "integer",
"last-proc-connection-dn": "integer",
"last-rmf-ready": "integer",
"partner-proc-connected": "boolean"
}
AMT-GATEWAYS - Retrieve
Retrieve operation of resource: amt-gateways
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"amt-gateway": [
{
"amt-nonce": "integer",
"amtgw": "string",
"mem-upd-in": "integer",
"key-len": "integer",
"mem-upd-out": "integer",
"amtnh": "integer",
"amt-port": "integer",
"idb": "integer"
}
]
}
AMT-GATEWAY - Retrieve
Retrieve operation of resource: amt-gateway
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"amt-nonce": "integer",
"amtgw": "string",
"mem-upd-in": "integer",
"key-len": "integer",
"mem-upd-out": "integer",
"amtnh": "integer",
"amt-port": "integer",
"idb": "integer"
}
UNICAST-QOS-ADJUST-STATS - Retrieve
Retrieve operation of resource: unicast-qos-adjust-stats
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-qos-s-sweeped": "boolean",
"batches": "integer",
"send-errors": "integer",
"last-download-time": "integer",
"sent-resync-bulks": "integer",
"is-resync-required": "boolean",
"queues": "integer",
"is-resync-start-sent": "boolean",
"send-partial-errors": "integer",
"last-sweep-time": "integer",
"send-success": "integer",
"is-resync-received": "boolean",
"add-to-batches": "integer",
"received-resync-requests": "integer",
"send-comm-errors": "integer",
"delete-to-batches": "integer"
}
BVI-STATISTICS - Retrieve
Retrieve operation of resource: bvi-statistics
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"tx-unknown-mrouter-msg": "integer",
"send-blocks": "integer",
"tx-protocol-buffers": "integer",
"rx-ipc-close-notif": "integer",
"rx-ipc-publish-notif": "integer",
"wtx-msg-proto-sent": "integer",
"rx-igmp-packet-success": "integer",
"rx-ipc-open-notif": "integer",
"rx-sweep-mrouter-msg": "integer",
"rx-ipc-lwm-notif": "integer",
"wtx-msg-drop-nomem": "integer",
"rx-delete-mrouter-msg": "integer",
"wtx-msg-freed": "integer",
"rx-ipc-q-full-notif": "integer",
"receive-buffers": "integer",
"rx-add-mrouter-msg": "integer",
"tx-add-mrouter-msg": "integer",
"rx-ipc-input-wait-notif": "integer",
"tx-sweep-mrouter-msg": "integer",
"tx-unknown-buffers": "integer",
"rx-ipc-send-status-notif": "integer",
"rx-ipc-output-notif": "integer",
"wtx-msg-drop-dc": "integer",
"null-buffer-handles": "integer",
"tx-delete-mrouter-msg": "integer",
"rx-ipc-error-notif": "integer",
"rx-unknown-mrouter-msg": "integer",
"release-buffers": "integer",
"release-fail-buffers": "integer",
"tx-buffer-errors": "integer",
"tx-mrouter-buffers": "integer",
"tx-buffers": "integer",
"wtx-msg-recvd": "integer",
"wtx-msg-sent": "integer",
"rx-ipc-connect-notif": "integer"
}
NSF - Retrieve
Retrieve operation of resource: nsf
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"last-nsf-off": "string",
"last-icd-notif-recv-min": "string",
"multicast-nsf-time-left": "integer",
"is-multicast-nsf-active": "boolean",
"last-icd-notif-recv": "string",
"multicast-nsf-timeout": "integer",
"respawn-count": "integer",
"last-nsf-on-min": "string",
"last-nsf-on": "string",
"last-nsf-off-min": "string"
}
DEFAULT-CONTEXT - Retrieve
Retrieve operation of resource: default-context
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-state-offs": {
"interface-state-off": [
{
"interface-name": "string",
"las-ll-remove-update-count": "integer",
"las-ll-add-update-count": "integer",
"las-update-count": "integer",
"configurationvrf-set": "boolean",
"vrf-id": "integer",
"subscriber-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"vrf-state": "integer",
"last-member-query-interval": "integer",
"interface-name-xr": "string",
"is-las-registered": "boolean",
"group-leaves": "integer",
"is-router-enabled": "boolean",
"las-get-address-count": "integer",
"subscriber-mode": "integer",
"total-active-groups": "integer",
"configuration-mcast-vrf-set": "boolean",
"querier-uptime": "integer",
"proxy-interface": "string",
"is-subscriber": "boolean",
"mte-vrf-id": "integer",
"state": "string",
"time-since-last-query-in-seconds": "integer",
"location": "integer",
"subscriber-id": "string",
"is-ip-enabled": "boolean",
"router-uptime-in-seconds": "integer",
"parent-ifhandle": "string",
"query-interval": "integer",
"configuration-mcast-vrf-error": "boolean",
"is-identity-present": "boolean",
"query-timeout": "integer",
"query-maximum-response-time": "integer",
"querier-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"igmp-version": "integer",
"las-ll-registration-count": "integer",
"is-interface-up": "boolean",
"mte-tuple-count": "integer",
"is-las-request": "boolean",
"prefix-length": "integer",
"las-null-update-count": "integer",
"is-querier": "boolean",
"robustness": "integer",
"las-unregistration-count": "integer",
"is-im-state-registered": "boolean",
"mtu": "integer",
"is-configurationverify": "boolean",
"time-since-last-report-in-seconds": "integer",
"configurationvrf-error": "boolean",
"host-version": "integer",
"group-joins": "integer"
}
]
}
}
SUMMARY - Retrieve
Retrieve operation of resource: summary
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"group-count": "integer",
"disabled-interface-count": "integer",
"group-limit": "integer",
"supported-interfaces": "integer",
"robustness": "integer",
"is-disabled": "boolean",
"enabled-interface-count": "integer",
"node-low-memory": "boolean",
"unsupported-interfaces": "integer",
"tunnel-mte-config-count": "integer",
"interface": [
{
"group-count": "integer",
"parent-ifhandle": "string",
"router-uptime-in-seconds": "integer",
"interface-name": "string",
"group-limit": "integer",
"on-off": "boolean",
"time-since-last-report-in-seconds": "integer",
"time-since-last-query-in-seconds": "integer"
}
]
}
INTERFACE - Retrieve
Retrieve operation of resource: interface
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"group-count": "integer",
"parent-ifhandle": "string",
"router-uptime-in-seconds": "integer",
"interface-name": "string",
"group-limit": "integer",
"on-off": "boolean",
"time-since-last-report-in-seconds": "integer",
"time-since-last-query-in-seconds": "integer"
}
INTERFACE-STATE-ONS - Retrieve
Retrieve operation of resource: interface-state-ons
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-state-on": [
{
"las-ll-remove-update-count": "integer",
"las-ll-add-update-count": "integer",
"las-update-count": "integer",
"configurationvrf-set": "boolean",
"vrf-id": "integer",
"subscriber-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"vrf-state": "integer",
"last-member-query-interval": "integer",
"interface-name-xr": "string",
"is-las-registered": "boolean",
"group-leaves": "integer",
"is-router-enabled": "boolean",
"las-get-address-count": "integer",
"subscriber-mode": "integer",
"total-active-groups": "integer",
"configuration-mcast-vrf-set": "boolean",
"querier-uptime": "integer",
"proxy-interface": "string",
"is-subscriber": "boolean",
"mte-vrf-id": "integer",
"state": "string",
"time-since-last-query-in-seconds": "integer",
"location": "integer",
"subscriber-id": "string",
"is-ip-enabled": "boolean",
"router-uptime-in-seconds": "integer",
"parent-ifhandle": "string",
"query-interval": "integer",
"configuration-mcast-vrf-error": "boolean",
"is-identity-present": "boolean",
"query-timeout": "integer",
"query-maximum-response-time": "integer",
"querier-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"igmp-version": "integer",
"las-ll-registration-count": "integer",
"is-interface-up": "boolean",
"mte-tuple-count": "integer",
"is-las-request": "boolean",
"prefix-length": "integer",
"las-null-update-count": "integer",
"is-querier": "boolean",
"robustness": "integer",
"las-unregistration-count": "integer",
"is-im-state-registered": "boolean",
"mtu": "integer",
"is-configurationverify": "boolean",
"time-since-last-report-in-seconds": "integer",
"configurationvrf-error": "boolean",
"host-version": "integer",
"group-joins": "integer"
}
]
}
INTERFACE-STATE-ON - Retrieve
Retrieve operation of resource: interface-state-on
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"las-ll-remove-update-count": "integer",
"las-ll-add-update-count": "integer",
"las-update-count": "integer",
"configurationvrf-set": "boolean",
"vrf-id": "integer",
"subscriber-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"vrf-state": "integer",
"last-member-query-interval": "integer",
"interface-name-xr": "string",
"is-las-registered": "boolean",
"group-leaves": "integer",
"is-router-enabled": "boolean",
"las-get-address-count": "integer",
"subscriber-mode": "integer",
"total-active-groups": "integer",
"configuration-mcast-vrf-set": "boolean",
"querier-uptime": "integer",
"proxy-interface": "string",
"is-subscriber": "boolean",
"mte-vrf-id": "integer",
"state": "string",
"time-since-last-query-in-seconds": "integer",
"location": "integer",
"subscriber-id": "string",
"is-ip-enabled": "boolean",
"router-uptime-in-seconds": "integer",
"parent-ifhandle": "string",
"query-interval": "integer",
"configuration-mcast-vrf-error": "boolean",
"is-identity-present": "boolean",
"query-timeout": "integer",
"query-maximum-response-time": "integer",
"querier-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"igmp-version": "integer",
"las-ll-registration-count": "integer",
"is-interface-up": "boolean",
"mte-tuple-count": "integer",
"is-las-request": "boolean",
"prefix-length": "integer",
"las-null-update-count": "integer",
"is-querier": "boolean",
"robustness": "integer",
"las-unregistration-count": "integer",
"is-im-state-registered": "boolean",
"mtu": "integer",
"is-configurationverify": "boolean",
"time-since-last-report-in-seconds": "integer",
"configurationvrf-error": "boolean",
"host-version": "integer",
"group-joins": "integer"
}
ADDRESS - Retrieve
Retrieve operation of resource: address
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
QUERIER-ADDRESS - Retrieve
Retrieve operation of resource: querier-address
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SUBSCRIBER-ADDRESS - Retrieve
Retrieve operation of resource: subscriber-address
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
DETAIL-GROUPS - Retrieve
Retrieve operation of resource: detail-groups
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"detail-group": [
{
"source": [
{
"uptime": "integer",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"expiration-time": "string",
"is-local": "boolean",
"is-forward": "boolean",
"is-added": "boolean",
"flags": "string",
"is-remote": "boolean",
"is-we-report": "boolean"
}
],
"is-router-exclude-mode": "boolean",
"group-info": {
"uptime": "integer",
"older-host-version1-timer": "integer",
"row-status": "string",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-added": "boolean",
"older-host-version2-timer": "integer",
"last-reporter": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"expiration-time": "string",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-suppressed": "boolean",
"is-self-join": "boolean",
"is-low-memory": "boolean",
"interface-name-xr": "string",
"router-filter-mode": "integer",
"explicit-tracking-enabled": "boolean"
},
"is-host-exclude-mode": "boolean"
}
]
}
DETAIL-GROUP - Retrieve
Retrieve operation of resource: detail-group
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"source": [
{
"uptime": "integer",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"expiration-time": "string",
"is-local": "boolean",
"is-forward": "boolean",
"is-added": "boolean",
"flags": "string",
"is-remote": "boolean",
"is-we-report": "boolean"
}
],
"is-router-exclude-mode": "boolean",
"group-info": {
"uptime": "integer",
"older-host-version1-timer": "integer",
"row-status": "string",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-added": "boolean",
"older-host-version2-timer": "integer",
"last-reporter": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"expiration-time": "string",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-suppressed": "boolean",
"is-self-join": "boolean",
"is-low-memory": "boolean",
"interface-name-xr": "string",
"router-filter-mode": "integer",
"explicit-tracking-enabled": "boolean"
},
"is-host-exclude-mode": "boolean"
}
GROUP-INFO - Retrieve
Retrieve operation of resource: group-info
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"uptime": "integer",
"older-host-version1-timer": "integer",
"row-status": "string",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-added": "boolean",
"older-host-version2-timer": "integer",
"last-reporter": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"expiration-time": "string",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-suppressed": "boolean",
"is-self-join": "boolean",
"is-low-memory": "boolean",
"interface-name-xr": "string",
"router-filter-mode": "integer",
"explicit-tracking-enabled": "boolean"
}
GROUP-ADDRESS-XR - Retrieve
Retrieve operation of resource: group-address-xr
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
LAST-REPORTER - Retrieve
Retrieve operation of resource: last-reporter
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SOURCE-ADDRESS - Retrieve
Retrieve operation of resource: source-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SOURCE - Retrieve
Retrieve operation of resource: source
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"uptime": "integer",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"expiration-time": "string",
"is-local": "boolean",
"is-forward": "boolean",
"is-added": "boolean",
"flags": "string",
"is-remote": "boolean",
"is-we-report": "boolean"
}
SOURCE-ADDRESS - Retrieve
Retrieve operation of resource: source-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
NON-ACTIVE-GROUPS - Retrieve
Retrieve operation of resource: non-active-groups
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"non-active-groups": [
{
"interface": "string",
"group-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"reason-for-non-activity": "string",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
}
NON-ACTIVE-GROUPS - Retrieve
Retrieve operation of resource: non-active-groups
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface": "string",
"group-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"reason-for-non-activity": "string",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
GROUP-ADDRESS - Retrieve
Retrieve operation of resource: group-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SOURCE-ADDRESS - Retrieve
Retrieve operation of resource: source-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SSM-MAPS - Retrieve
Retrieve operation of resource: ssm-maps
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ssm-map": [
{
"source-counts": "integer",
"map-type": "integer",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
}
SSM-MAP - Retrieve
Retrieve operation of resource: ssm-map
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"source-counts": "integer",
"map-type": "integer",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
GROUP-ADDRESS-XR - Retrieve
Retrieve operation of resource: group-address-xr
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
EXPLICIT-GROUPS - Retrieve
Retrieve operation of resource: explicit-groups
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"explicit-group": [
{
"exclude-hosts": "integer",
"host": [
{
"uptime": "integer",
"source-address": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"is-exclude": "boolean",
"expiration-time": "integer",
"source-count": "integer",
"address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
],
"include-hosts": "integer",
"group-info": {
"uptime": "integer",
"older-host-version1-timer": "integer",
"row-status": "string",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-added": "boolean",
"older-host-version2-timer": "integer",
"last-reporter": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"expiration-time": "string",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-suppressed": "boolean",
"is-self-join": "boolean",
"is-low-memory": "boolean",
"interface-name-xr": "string",
"router-filter-mode": "integer",
"explicit-tracking-enabled": "boolean"
}
}
]
}
EXPLICIT-GROUP - Retrieve
Retrieve operation of resource: explicit-group
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"exclude-hosts": "integer",
"host": [
{
"uptime": "integer",
"source-address": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"is-exclude": "boolean",
"expiration-time": "integer",
"source-count": "integer",
"address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
],
"include-hosts": "integer",
"group-info": {
"uptime": "integer",
"older-host-version1-timer": "integer",
"row-status": "string",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-added": "boolean",
"older-host-version2-timer": "integer",
"last-reporter": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"expiration-time": "string",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-suppressed": "boolean",
"is-self-join": "boolean",
"is-low-memory": "boolean",
"interface-name-xr": "string",
"router-filter-mode": "integer",
"explicit-tracking-enabled": "boolean"
}
}
GROUP-INFO - Retrieve
Retrieve operation of resource: group-info
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"uptime": "integer",
"older-host-version1-timer": "integer",
"row-status": "string",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-added": "boolean",
"older-host-version2-timer": "integer",
"last-reporter": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"expiration-time": "string",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-suppressed": "boolean",
"is-self-join": "boolean",
"is-low-memory": "boolean",
"interface-name-xr": "string",
"router-filter-mode": "integer",
"explicit-tracking-enabled": "boolean"
}
GROUP-ADDRESS-XR - Retrieve
Retrieve operation of resource: group-address-xr
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
LAST-REPORTER - Retrieve
Retrieve operation of resource: last-reporter
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SOURCE-ADDRESS - Retrieve
Retrieve operation of resource: source-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
HOST - Retrieve
Retrieve operation of resource: host
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"uptime": "integer",
"source-address": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"is-exclude": "boolean",
"expiration-time": "integer",
"source-count": "integer",
"address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
ADDRESS - Retrieve
Retrieve operation of resource: address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SOURCE-ADDRESS - Retrieve
Retrieve operation of resource: source-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
INTERFACE-TABLE - Retrieve
Retrieve operation of resource: interface-table
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface": [
{
"interface-name": "string",
"las-ll-remove-update-count": "integer",
"las-ll-add-update-count": "integer",
"las-update-count": "integer",
"configurationvrf-set": "boolean",
"vrf-id": "integer",
"subscriber-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"vrf-state": "integer",
"last-member-query-interval": "integer",
"interface-name-xr": "string",
"is-las-registered": "boolean",
"group-leaves": "integer",
"is-router-enabled": "boolean",
"las-get-address-count": "integer",
"subscriber-mode": "integer",
"total-active-groups": "integer",
"configuration-mcast-vrf-set": "boolean",
"querier-uptime": "integer",
"proxy-interface": "string",
"is-subscriber": "boolean",
"mte-vrf-id": "integer",
"state": "string",
"time-since-last-query-in-seconds": "integer",
"location": "integer",
"subscriber-id": "string",
"is-ip-enabled": "boolean",
"router-uptime-in-seconds": "integer",
"parent-ifhandle": "string",
"query-interval": "integer",
"configuration-mcast-vrf-error": "boolean",
"is-identity-present": "boolean",
"query-timeout": "integer",
"query-maximum-response-time": "integer",
"querier-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"igmp-version": "integer",
"las-ll-registration-count": "integer",
"is-interface-up": "boolean",
"mte-tuple-count": "integer",
"is-las-request": "boolean",
"prefix-length": "integer",
"las-null-update-count": "integer",
"is-querier": "boolean",
"robustness": "integer",
"las-unregistration-count": "integer",
"is-im-state-registered": "boolean",
"mtu": "integer",
"is-configurationverify": "boolean",
"time-since-last-report-in-seconds": "integer",
"configurationvrf-error": "boolean",
"host-version": "integer",
"group-joins": "integer"
}
]
}
INTERFACE - Retrieve
Retrieve operation of resource: interface
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"las-ll-remove-update-count": "integer",
"las-ll-add-update-count": "integer",
"las-update-count": "integer",
"configurationvrf-set": "boolean",
"vrf-id": "integer",
"subscriber-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"vrf-state": "integer",
"last-member-query-interval": "integer",
"interface-name-xr": "string",
"is-las-registered": "boolean",
"group-leaves": "integer",
"is-router-enabled": "boolean",
"las-get-address-count": "integer",
"subscriber-mode": "integer",
"total-active-groups": "integer",
"configuration-mcast-vrf-set": "boolean",
"querier-uptime": "integer",
"proxy-interface": "string",
"is-subscriber": "boolean",
"mte-vrf-id": "integer",
"state": "string",
"time-since-last-query-in-seconds": "integer",
"location": "integer",
"subscriber-id": "string",
"is-ip-enabled": "boolean",
"router-uptime-in-seconds": "integer",
"parent-ifhandle": "string",
"query-interval": "integer",
"configuration-mcast-vrf-error": "boolean",
"is-identity-present": "boolean",
"query-timeout": "integer",
"query-maximum-response-time": "integer",
"querier-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"igmp-version": "integer",
"las-ll-registration-count": "integer",
"is-interface-up": "boolean",
"mte-tuple-count": "integer",
"is-las-request": "boolean",
"prefix-length": "integer",
"las-null-update-count": "integer",
"is-querier": "boolean",
"robustness": "integer",
"las-unregistration-count": "integer",
"is-im-state-registered": "boolean",
"mtu": "integer",
"is-configurationverify": "boolean",
"time-since-last-report-in-seconds": "integer",
"configurationvrf-error": "boolean",
"host-version": "integer",
"group-joins": "integer"
}
ADDRESS - Retrieve
Retrieve operation of resource: address
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
QUERIER-ADDRESS - Retrieve
Retrieve operation of resource: querier-address
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SUBSCRIBER-ADDRESS - Retrieve
Retrieve operation of resource: subscriber-address
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
INTERFACE-UNICAST-QOS-ADJUSTS - Retrieve
Retrieve operation of resource: interface-unicast-qos-adjusts
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-unicast-qos-adjust": [
{
"is-virtual-access": "boolean",
"rate": "integer",
"rate-increments": "integer",
"rate-decrements": "integer",
"update": [
{
"is-add": "boolean",
"group-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"received-time": "integer",
"weight": "integer",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
}
]
}
INTERFACE-UNICAST-QOS-ADJUST - Retrieve
Retrieve operation of resource: interface-unicast-qos-adjust
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-virtual-access": "boolean",
"rate": "integer",
"rate-increments": "integer",
"rate-decrements": "integer",
"update": [
{
"is-add": "boolean",
"group-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"received-time": "integer",
"weight": "integer",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
}
UPDATE - Retrieve
Retrieve operation of resource: update
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-add": "boolean",
"group-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"received-time": "integer",
"weight": "integer",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
SOURCE-ADDRESS - Retrieve
Retrieve operation of resource: source-address
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
GROUP-ADDRESS - Retrieve
Retrieve operation of resource: group-address
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
RANGES - Retrieve
Retrieve operation of resource: ranges
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"range": [
{
"is-stale": "boolean",
"protocol": "string",
"prefix-length": "integer",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
}
RANGE - Retrieve
Retrieve operation of resource: range
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-stale": "boolean",
"protocol": "string",
"prefix-length": "integer",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
GROUP-ADDRESS-XR - Retrieve
Retrieve operation of resource: group-address-xr
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
IFRS-INTERFACES - Retrieve
Retrieve operation of resource: ifrs-interfaces
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ifrs-interface": [
{
"join-group-count": "integer",
"igmp-interface-entry": {
"las-ll-remove-update-count": "integer",
"las-ll-add-update-count": "integer",
"las-update-count": "integer",
"configurationvrf-set": "boolean",
"vrf-id": "integer",
"subscriber-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"vrf-state": "integer",
"last-member-query-interval": "integer",
"interface-name-xr": "string",
"is-las-registered": "boolean",
"group-leaves": "integer",
"is-router-enabled": "boolean",
"las-get-address-count": "integer",
"subscriber-mode": "integer",
"total-active-groups": "integer",
"configuration-mcast-vrf-set": "boolean",
"querier-uptime": "integer",
"proxy-interface": "string",
"is-subscriber": "boolean",
"mte-vrf-id": "integer",
"state": "string",
"time-since-last-query-in-seconds": "integer",
"location": "integer",
"subscriber-id": "string",
"is-ip-enabled": "boolean",
"router-uptime-in-seconds": "integer",
"parent-ifhandle": "string",
"query-interval": "integer",
"configuration-mcast-vrf-error": "boolean",
"is-identity-present": "boolean",
"query-timeout": "integer",
"query-maximum-response-time": "integer",
"querier-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"igmp-version": "integer",
"las-ll-registration-count": "integer",
"is-interface-up": "boolean",
"mte-tuple-count": "integer",
"is-las-request": "boolean",
"prefix-length": "integer",
"las-null-update-count": "integer",
"is-querier": "boolean",
"robustness": "integer",
"las-unregistration-count": "integer",
"is-im-state-registered": "boolean",
"mtu": "integer",
"is-configurationverify": "boolean",
"time-since-last-report-in-seconds": "integer",
"configurationvrf-error": "boolean",
"host-version": "integer",
"group-joins": "integer"
}
}
]
}
IFRS-INTERFACE - Retrieve
Retrieve operation of resource: ifrs-interface
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"join-group-count": "integer",
"igmp-interface-entry": {
"las-ll-remove-update-count": "integer",
"las-ll-add-update-count": "integer",
"las-update-count": "integer",
"configurationvrf-set": "boolean",
"vrf-id": "integer",
"subscriber-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"vrf-state": "integer",
"last-member-query-interval": "integer",
"interface-name-xr": "string",
"is-las-registered": "boolean",
"group-leaves": "integer",
"is-router-enabled": "boolean",
"las-get-address-count": "integer",
"subscriber-mode": "integer",
"total-active-groups": "integer",
"configuration-mcast-vrf-set": "boolean",
"querier-uptime": "integer",
"proxy-interface": "string",
"is-subscriber": "boolean",
"mte-vrf-id": "integer",
"state": "string",
"time-since-last-query-in-seconds": "integer",
"location": "integer",
"subscriber-id": "string",
"is-ip-enabled": "boolean",
"router-uptime-in-seconds": "integer",
"parent-ifhandle": "string",
"query-interval": "integer",
"configuration-mcast-vrf-error": "boolean",
"is-identity-present": "boolean",
"query-timeout": "integer",
"query-maximum-response-time": "integer",
"querier-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"igmp-version": "integer",
"las-ll-registration-count": "integer",
"is-interface-up": "boolean",
"mte-tuple-count": "integer",
"is-las-request": "boolean",
"prefix-length": "integer",
"las-null-update-count": "integer",
"is-querier": "boolean",
"robustness": "integer",
"las-unregistration-count": "integer",
"is-im-state-registered": "boolean",
"mtu": "integer",
"is-configurationverify": "boolean",
"time-since-last-report-in-seconds": "integer",
"configurationvrf-error": "boolean",
"host-version": "integer",
"group-joins": "integer"
}
}
IGMP-INTERFACE-ENTRY - Retrieve
Retrieve operation of resource: igmp-interface-entry
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"las-ll-remove-update-count": "integer",
"las-ll-add-update-count": "integer",
"las-update-count": "integer",
"configurationvrf-set": "boolean",
"vrf-id": "integer",
"subscriber-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"vrf-state": "integer",
"last-member-query-interval": "integer",
"interface-name-xr": "string",
"is-las-registered": "boolean",
"group-leaves": "integer",
"is-router-enabled": "boolean",
"las-get-address-count": "integer",
"subscriber-mode": "integer",
"total-active-groups": "integer",
"configuration-mcast-vrf-set": "boolean",
"querier-uptime": "integer",
"proxy-interface": "string",
"is-subscriber": "boolean",
"mte-vrf-id": "integer",
"state": "string",
"time-since-last-query-in-seconds": "integer",
"location": "integer",
"subscriber-id": "string",
"is-ip-enabled": "boolean",
"router-uptime-in-seconds": "integer",
"parent-ifhandle": "string",
"query-interval": "integer",
"configuration-mcast-vrf-error": "boolean",
"is-identity-present": "boolean",
"query-timeout": "integer",
"query-maximum-response-time": "integer",
"querier-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"igmp-version": "integer",
"las-ll-registration-count": "integer",
"is-interface-up": "boolean",
"mte-tuple-count": "integer",
"is-las-request": "boolean",
"prefix-length": "integer",
"las-null-update-count": "integer",
"is-querier": "boolean",
"robustness": "integer",
"las-unregistration-count": "integer",
"is-im-state-registered": "boolean",
"mtu": "integer",
"is-configurationverify": "boolean",
"time-since-last-report-in-seconds": "integer",
"configurationvrf-error": "boolean",
"host-version": "integer",
"group-joins": "integer"
}
ADDRESS - Retrieve
Retrieve operation of resource: address
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
QUERIER-ADDRESS - Retrieve
Retrieve operation of resource: querier-address
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SUBSCRIBER-ADDRESS - Retrieve
Retrieve operation of resource: subscriber-address
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
TRAFFIC-COUNTERS - Retrieve
Retrieve operation of resource: traffic-counters
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"checksum-errors": "integer",
"auxillary-data-length-errors": "integer",
"input-mtrace": "integer",
"socket-errors": "integer",
"packet-manager-input-errors": "integer",
"packets-out": "integer",
"input-no-idb": "integer",
"output-no-parent-interface-handle": "integer",
"receive-socket-errors": "integer",
"output-leaves": "integer",
"no-socket-connection": "integer",
"bad-scope-errors": "integer",
"input-leaves": "integer",
"invalid-source-address-errors": "integer",
"get-packet-failure": "integer",
"input-dvmrp": "integer",
"miscellaneous-errors": "integer",
"elapsed-time": "integer",
"input-no-platform-support-mtrace": "integer",
"input-queries": "integer",
"output-pim": "integer",
"input-disabled-idb": "integer",
"packet-manager-output-errors": "integer",
"format-errors": "integer",
"packets-in": "integer",
"input-no-vrf-mtrace": "integer",
"input-no-assigned-vrf-id": "integer",
"input-reports": "integer",
"input-pim": "integer",
"input-martian-address": "integer",
"output-queries": "integer",
"input-no-vrf-in-idb": "integer",
"output-mtrace": "integer",
"output-reports": "integer",
"output-dvmrp": "integer"
}
GROUPS - Retrieve
Retrieve operation of resource: groups
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"group": [
{
"uptime": "integer",
"older-host-version1-timer": "integer",
"row-status": "string",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-added": "boolean",
"older-host-version2-timer": "integer",
"last-reporter": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"expiration-time": "string",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-suppressed": "boolean",
"is-self-join": "boolean",
"is-low-memory": "boolean",
"interface-name-xr": "string",
"router-filter-mode": "integer",
"explicit-tracking-enabled": "boolean"
}
]
}
GROUP - Retrieve
Retrieve operation of resource: group
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"uptime": "integer",
"older-host-version1-timer": "integer",
"row-status": "string",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-added": "boolean",
"older-host-version2-timer": "integer",
"last-reporter": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"expiration-time": "string",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-suppressed": "boolean",
"is-self-join": "boolean",
"is-low-memory": "boolean",
"interface-name-xr": "string",
"router-filter-mode": "integer",
"explicit-tracking-enabled": "boolean"
}
GROUP-ADDRESS-XR - Retrieve
Retrieve operation of resource: group-address-xr
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
LAST-REPORTER - Retrieve
Retrieve operation of resource: last-reporter
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SOURCE-ADDRESS - Retrieve
Retrieve operation of resource: source-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
GROUP-SUMMARY - Retrieve
Retrieve operation of resource: group-summary
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"group-count": "integer",
"groutes": "integer",
"sg-routes": "integer",
"is-low-memory": "boolean"
}
IFRS-INTERFACE-SUMMARY - Retrieve
Retrieve operation of resource: ifrs-interface-summary
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-count": "integer",
"configuration-count": "integer"
}
GLOBAL-INTERFACE-TABLE - Retrieve
Retrieve operation of resource: global-interface-table
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface": [
{
"interface-name": "string",
"las-ll-remove-update-count": "integer",
"las-ll-add-update-count": "integer",
"las-update-count": "integer",
"configurationvrf-set": "boolean",
"vrf-id": "integer",
"subscriber-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"vrf-state": "integer",
"last-member-query-interval": "integer",
"interface-name-xr": "string",
"is-las-registered": "boolean",
"group-leaves": "integer",
"is-router-enabled": "boolean",
"las-get-address-count": "integer",
"subscriber-mode": "integer",
"total-active-groups": "integer",
"configuration-mcast-vrf-set": "boolean",
"querier-uptime": "integer",
"proxy-interface": "string",
"is-subscriber": "boolean",
"mte-vrf-id": "integer",
"state": "string",
"time-since-last-query-in-seconds": "integer",
"location": "integer",
"subscriber-id": "string",
"is-ip-enabled": "boolean",
"router-uptime-in-seconds": "integer",
"parent-ifhandle": "string",
"query-interval": "integer",
"configuration-mcast-vrf-error": "boolean",
"is-identity-present": "boolean",
"query-timeout": "integer",
"query-maximum-response-time": "integer",
"querier-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"igmp-version": "integer",
"las-ll-registration-count": "integer",
"is-interface-up": "boolean",
"mte-tuple-count": "integer",
"is-las-request": "boolean",
"prefix-length": "integer",
"las-null-update-count": "integer",
"is-querier": "boolean",
"robustness": "integer",
"las-unregistration-count": "integer",
"is-im-state-registered": "boolean",
"mtu": "integer",
"is-configurationverify": "boolean",
"time-since-last-report-in-seconds": "integer",
"configurationvrf-error": "boolean",
"host-version": "integer",
"group-joins": "integer"
}
]
}
INTERFACE - Retrieve
Retrieve operation of resource: interface
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"las-ll-remove-update-count": "integer",
"las-ll-add-update-count": "integer",
"las-update-count": "integer",
"configurationvrf-set": "boolean",
"vrf-id": "integer",
"subscriber-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"vrf-state": "integer",
"last-member-query-interval": "integer",
"interface-name-xr": "string",
"is-las-registered": "boolean",
"group-leaves": "integer",
"is-router-enabled": "boolean",
"las-get-address-count": "integer",
"subscriber-mode": "integer",
"total-active-groups": "integer",
"configuration-mcast-vrf-set": "boolean",
"querier-uptime": "integer",
"proxy-interface": "string",
"is-subscriber": "boolean",
"mte-vrf-id": "integer",
"state": "string",
"time-since-last-query-in-seconds": "integer",
"location": "integer",
"subscriber-id": "string",
"is-ip-enabled": "boolean",
"router-uptime-in-seconds": "integer",
"parent-ifhandle": "string",
"query-interval": "integer",
"configuration-mcast-vrf-error": "boolean",
"is-identity-present": "boolean",
"query-timeout": "integer",
"query-maximum-response-time": "integer",
"querier-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"igmp-version": "integer",
"las-ll-registration-count": "integer",
"is-interface-up": "boolean",
"mte-tuple-count": "integer",
"is-las-request": "boolean",
"prefix-length": "integer",
"las-null-update-count": "integer",
"is-querier": "boolean",
"robustness": "integer",
"las-unregistration-count": "integer",
"is-im-state-registered": "boolean",
"mtu": "integer",
"is-configurationverify": "boolean",
"time-since-last-report-in-seconds": "integer",
"configurationvrf-error": "boolean",
"host-version": "integer",
"group-joins": "integer"
}
ADDRESS - Retrieve
Retrieve operation of resource: address
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
QUERIER-ADDRESS - Retrieve
Retrieve operation of resource: querier-address
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SUBSCRIBER-ADDRESS - Retrieve
Retrieve operation of resource: subscriber-address
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SSM-MAP-DETAILS - Retrieve
Retrieve operation of resource: ssm-map-details
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ssm-map-detail": [
{
"response-pending": "boolean",
"query-interval": "integer",
"map-info": {
"source-counts": "integer",
"map-type": "integer",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
},
"expiration-time": "integer",
"sources": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"elapsed-time": "integer"
}
]
}
SSM-MAP-DETAIL - Retrieve
Retrieve operation of resource: ssm-map-detail
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"response-pending": "boolean",
"query-interval": "integer",
"map-info": {
"source-counts": "integer",
"map-type": "integer",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
},
"expiration-time": "integer",
"sources": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"elapsed-time": "integer"
}
MAP-INFO - Retrieve
Retrieve operation of resource: map-info
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"source-counts": "integer",
"map-type": "integer",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
GROUP-ADDRESS-XR - Retrieve
Retrieve operation of resource: group-address-xr
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SOURCES - Retrieve
Retrieve operation of resource: sources
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
INTERFACE-STATE-OFFS - Retrieve
Retrieve operation of resource: interface-state-offs
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-state-off": [
{
"las-ll-remove-update-count": "integer",
"las-ll-add-update-count": "integer",
"las-update-count": "integer",
"configurationvrf-set": "boolean",
"vrf-id": "integer",
"subscriber-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"vrf-state": "integer",
"last-member-query-interval": "integer",
"interface-name-xr": "string",
"is-las-registered": "boolean",
"group-leaves": "integer",
"is-router-enabled": "boolean",
"las-get-address-count": "integer",
"subscriber-mode": "integer",
"total-active-groups": "integer",
"configuration-mcast-vrf-set": "boolean",
"querier-uptime": "integer",
"proxy-interface": "string",
"is-subscriber": "boolean",
"mte-vrf-id": "integer",
"state": "string",
"time-since-last-query-in-seconds": "integer",
"location": "integer",
"subscriber-id": "string",
"is-ip-enabled": "boolean",
"router-uptime-in-seconds": "integer",
"parent-ifhandle": "string",
"query-interval": "integer",
"configuration-mcast-vrf-error": "boolean",
"is-identity-present": "boolean",
"query-timeout": "integer",
"query-maximum-response-time": "integer",
"querier-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"igmp-version": "integer",
"las-ll-registration-count": "integer",
"is-interface-up": "boolean",
"mte-tuple-count": "integer",
"is-las-request": "boolean",
"prefix-length": "integer",
"las-null-update-count": "integer",
"is-querier": "boolean",
"robustness": "integer",
"las-unregistration-count": "integer",
"is-im-state-registered": "boolean",
"mtu": "integer",
"is-configurationverify": "boolean",
"time-since-last-report-in-seconds": "integer",
"configurationvrf-error": "boolean",
"host-version": "integer",
"group-joins": "integer"
}
]
}
INTERFACE-STATE-OFF - Retrieve
Retrieve operation of resource: interface-state-off
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"las-ll-remove-update-count": "integer",
"las-ll-add-update-count": "integer",
"las-update-count": "integer",
"configurationvrf-set": "boolean",
"vrf-id": "integer",
"subscriber-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"vrf-state": "integer",
"last-member-query-interval": "integer",
"interface-name-xr": "string",
"is-las-registered": "boolean",
"group-leaves": "integer",
"is-router-enabled": "boolean",
"las-get-address-count": "integer",
"subscriber-mode": "integer",
"total-active-groups": "integer",
"configuration-mcast-vrf-set": "boolean",
"querier-uptime": "integer",
"proxy-interface": "string",
"is-subscriber": "boolean",
"mte-vrf-id": "integer",
"state": "string",
"time-since-last-query-in-seconds": "integer",
"location": "integer",
"subscriber-id": "string",
"is-ip-enabled": "boolean",
"router-uptime-in-seconds": "integer",
"parent-ifhandle": "string",
"query-interval": "integer",
"configuration-mcast-vrf-error": "boolean",
"is-identity-present": "boolean",
"query-timeout": "integer",
"query-maximum-response-time": "integer",
"querier-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"igmp-version": "integer",
"las-ll-registration-count": "integer",
"is-interface-up": "boolean",
"mte-tuple-count": "integer",
"is-las-request": "boolean",
"prefix-length": "integer",
"las-null-update-count": "integer",
"is-querier": "boolean",
"robustness": "integer",
"las-unregistration-count": "integer",
"is-im-state-registered": "boolean",
"mtu": "integer",
"is-configurationverify": "boolean",
"time-since-last-report-in-seconds": "integer",
"configurationvrf-error": "boolean",
"host-version": "integer",
"group-joins": "integer"
}
ADDRESS - Retrieve
Retrieve operation of resource: address
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
QUERIER-ADDRESS - Retrieve
Retrieve operation of resource: querier-address
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SUBSCRIBER-ADDRESS - Retrieve
Retrieve operation of resource: subscriber-address
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
ACTIVE - Retrieve
Retrieve operation of resource: active
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"default-context": {
"interface-state-offs": {
"interface-state-off": [
{
"interface-name": "string",
"las-ll-remove-update-count": "integer",
"las-ll-add-update-count": "integer",
"las-update-count": "integer",
"configurationvrf-set": "boolean",
"vrf-id": "integer",
"subscriber-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"vrf-state": "integer",
"last-member-query-interval": "integer",
"interface-name-xr": "string",
"is-las-registered": "boolean",
"group-leaves": "integer",
"is-router-enabled": "boolean",
"las-get-address-count": "integer",
"subscriber-mode": "integer",
"total-active-groups": "integer",
"configuration-mcast-vrf-set": "boolean",
"querier-uptime": "integer",
"proxy-interface": "string",
"is-subscriber": "boolean",
"mte-vrf-id": "integer",
"state": "string",
"time-since-last-query-in-seconds": "integer",
"location": "integer",
"subscriber-id": "string",
"is-ip-enabled": "boolean",
"router-uptime-in-seconds": "integer",
"parent-ifhandle": "string",
"query-interval": "integer",
"configuration-mcast-vrf-error": "boolean",
"is-identity-present": "boolean",
"query-timeout": "integer",
"query-maximum-response-time": "integer",
"querier-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"igmp-version": "integer",
"las-ll-registration-count": "integer",
"is-interface-up": "boolean",
"mte-tuple-count": "integer",
"is-las-request": "boolean",
"prefix-length": "integer",
"las-null-update-count": "integer",
"is-querier": "boolean",
"robustness": "integer",
"las-unregistration-count": "integer",
"is-im-state-registered": "boolean",
"mtu": "integer",
"is-configurationverify": "boolean",
"time-since-last-report-in-seconds": "integer",
"configurationvrf-error": "boolean",
"host-version": "integer",
"group-joins": "integer"
}
]
}
}
}
VRFS - Retrieve
Retrieve operation of resource: vrfs
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"vrf": [
{
"interface-state-offs": {
"interface-state-off": [
{
"interface-name": "string",
"las-ll-remove-update-count": "integer",
"las-ll-add-update-count": "integer",
"las-update-count": "integer",
"configurationvrf-set": "boolean",
"vrf-id": "integer",
"subscriber-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"vrf-state": "integer",
"last-member-query-interval": "integer",
"interface-name-xr": "string",
"is-las-registered": "boolean",
"group-leaves": "integer",
"is-router-enabled": "boolean",
"las-get-address-count": "integer",
"subscriber-mode": "integer",
"total-active-groups": "integer",
"configuration-mcast-vrf-set": "boolean",
"querier-uptime": "integer",
"proxy-interface": "string",
"is-subscriber": "boolean",
"mte-vrf-id": "integer",
"state": "string",
"time-since-last-query-in-seconds": "integer",
"location": "integer",
"subscriber-id": "string",
"is-ip-enabled": "boolean",
"router-uptime-in-seconds": "integer",
"parent-ifhandle": "string",
"query-interval": "integer",
"configuration-mcast-vrf-error": "boolean",
"is-identity-present": "boolean",
"query-timeout": "integer",
"query-maximum-response-time": "integer",
"querier-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"igmp-version": "integer",
"las-ll-registration-count": "integer",
"is-interface-up": "boolean",
"mte-tuple-count": "integer",
"is-las-request": "boolean",
"prefix-length": "integer",
"las-null-update-count": "integer",
"is-querier": "boolean",
"robustness": "integer",
"las-unregistration-count": "integer",
"is-im-state-registered": "boolean",
"mtu": "integer",
"is-configurationverify": "boolean",
"time-since-last-report-in-seconds": "integer",
"configurationvrf-error": "boolean",
"host-version": "integer",
"group-joins": "integer"
}
]
}
}
]
}
VRF - Retrieve
Retrieve operation of resource: vrf
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-state-offs": {
"interface-state-off": [
{
"interface-name": "string",
"las-ll-remove-update-count": "integer",
"las-ll-add-update-count": "integer",
"las-update-count": "integer",
"configurationvrf-set": "boolean",
"vrf-id": "integer",
"subscriber-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"vrf-state": "integer",
"last-member-query-interval": "integer",
"interface-name-xr": "string",
"is-las-registered": "boolean",
"group-leaves": "integer",
"is-router-enabled": "boolean",
"las-get-address-count": "integer",
"subscriber-mode": "integer",
"total-active-groups": "integer",
"configuration-mcast-vrf-set": "boolean",
"querier-uptime": "integer",
"proxy-interface": "string",
"is-subscriber": "boolean",
"mte-vrf-id": "integer",
"state": "string",
"time-since-last-query-in-seconds": "integer",
"location": "integer",
"subscriber-id": "string",
"is-ip-enabled": "boolean",
"router-uptime-in-seconds": "integer",
"parent-ifhandle": "string",
"query-interval": "integer",
"configuration-mcast-vrf-error": "boolean",
"is-identity-present": "boolean",
"query-timeout": "integer",
"query-maximum-response-time": "integer",
"querier-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"igmp-version": "integer",
"las-ll-registration-count": "integer",
"is-interface-up": "boolean",
"mte-tuple-count": "integer",
"is-las-request": "boolean",
"prefix-length": "integer",
"las-null-update-count": "integer",
"is-querier": "boolean",
"robustness": "integer",
"las-unregistration-count": "integer",
"is-im-state-registered": "boolean",
"mtu": "integer",
"is-configurationverify": "boolean",
"time-since-last-report-in-seconds": "integer",
"configurationvrf-error": "boolean",
"host-version": "integer",
"group-joins": "integer"
}
]
}
}
SUMMARY - Retrieve
Retrieve operation of resource: summary
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"group-count": "integer",
"disabled-interface-count": "integer",
"group-limit": "integer",
"supported-interfaces": "integer",
"robustness": "integer",
"is-disabled": "boolean",
"enabled-interface-count": "integer",
"node-low-memory": "boolean",
"unsupported-interfaces": "integer",
"tunnel-mte-config-count": "integer",
"interface": [
{
"group-count": "integer",
"parent-ifhandle": "string",
"router-uptime-in-seconds": "integer",
"interface-name": "string",
"group-limit": "integer",
"on-off": "boolean",
"time-since-last-report-in-seconds": "integer",
"time-since-last-query-in-seconds": "integer"
}
]
}
INTERFACE - Retrieve
Retrieve operation of resource: interface
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"group-count": "integer",
"parent-ifhandle": "string",
"router-uptime-in-seconds": "integer",
"interface-name": "string",
"group-limit": "integer",
"on-off": "boolean",
"time-since-last-report-in-seconds": "integer",
"time-since-last-query-in-seconds": "integer"
}
INTERFACE-STATE-ONS - Retrieve
Retrieve operation of resource: interface-state-ons
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-state-on": [
{
"las-ll-remove-update-count": "integer",
"las-ll-add-update-count": "integer",
"las-update-count": "integer",
"configurationvrf-set": "boolean",
"vrf-id": "integer",
"subscriber-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"vrf-state": "integer",
"last-member-query-interval": "integer",
"interface-name-xr": "string",
"is-las-registered": "boolean",
"group-leaves": "integer",
"is-router-enabled": "boolean",
"las-get-address-count": "integer",
"subscriber-mode": "integer",
"total-active-groups": "integer",
"configuration-mcast-vrf-set": "boolean",
"querier-uptime": "integer",
"proxy-interface": "string",
"is-subscriber": "boolean",
"mte-vrf-id": "integer",
"state": "string",
"time-since-last-query-in-seconds": "integer",
"location": "integer",
"subscriber-id": "string",
"is-ip-enabled": "boolean",
"router-uptime-in-seconds": "integer",
"parent-ifhandle": "string",
"query-interval": "integer",
"configuration-mcast-vrf-error": "boolean",
"is-identity-present": "boolean",
"query-timeout": "integer",
"query-maximum-response-time": "integer",
"querier-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"igmp-version": "integer",
"las-ll-registration-count": "integer",
"is-interface-up": "boolean",
"mte-tuple-count": "integer",
"is-las-request": "boolean",
"prefix-length": "integer",
"las-null-update-count": "integer",
"is-querier": "boolean",
"robustness": "integer",
"las-unregistration-count": "integer",
"is-im-state-registered": "boolean",
"mtu": "integer",
"is-configurationverify": "boolean",
"time-since-last-report-in-seconds": "integer",
"configurationvrf-error": "boolean",
"host-version": "integer",
"group-joins": "integer"
}
]
}
INTERFACE-STATE-ON - Retrieve
Retrieve operation of resource: interface-state-on
vrf-name
in path
string
ID of vrf-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"las-ll-remove-update-count": "integer",
"las-ll-add-update-count": "integer",
"las-update-count": "integer",
"configurationvrf-set": "boolean",
"vrf-id": "integer",
"subscriber-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"vrf-state": "integer",
"last-member-query-interval": "integer",
"interface-name-xr": "string",
"is-las-registered": "boolean",
"group-leaves": "integer",
"is-router-enabled": "boolean",
"las-get-address-count": "integer",
"subscriber-mode": "integer",
"total-active-groups": "integer",
"configuration-mcast-vrf-set": "boolean",
"querier-uptime": "integer",
"proxy-interface": "string",
"is-subscriber": "boolean",
"mte-vrf-id": "integer",
"state": "string",
"time-since-last-query-in-seconds": "integer",
"location": "integer",
"subscriber-id": "string",
"is-ip-enabled": "boolean",
"router-uptime-in-seconds": "integer",
"parent-ifhandle": "string",
"query-interval": "integer",
"configuration-mcast-vrf-error": "boolean",
"is-identity-present": "boolean",
"query-timeout": "integer",
"query-maximum-response-time": "integer",
"querier-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"igmp-version": "integer",
"las-ll-registration-count": "integer",
"is-interface-up": "boolean",
"mte-tuple-count": "integer",
"is-las-request": "boolean",
"prefix-length": "integer",
"las-null-update-count": "integer",
"is-querier": "boolean",
"robustness": "integer",
"las-unregistration-count": "integer",
"is-im-state-registered": "boolean",
"mtu": "integer",
"is-configurationverify": "boolean",
"time-since-last-report-in-seconds": "integer",
"configurationvrf-error": "boolean",
"host-version": "integer",
"group-joins": "integer"
}
ADDRESS - Retrieve
Retrieve operation of resource: address
vrf-name
in path
string
ID of vrf-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
QUERIER-ADDRESS - Retrieve
Retrieve operation of resource: querier-address
vrf-name
in path
string
ID of vrf-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SUBSCRIBER-ADDRESS - Retrieve
Retrieve operation of resource: subscriber-address
vrf-name
in path
string
ID of vrf-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
DETAIL-GROUPS - Retrieve
Retrieve operation of resource: detail-groups
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"detail-group": [
{
"source": [
{
"uptime": "integer",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"expiration-time": "string",
"is-local": "boolean",
"is-forward": "boolean",
"is-added": "boolean",
"flags": "string",
"is-remote": "boolean",
"is-we-report": "boolean"
}
],
"is-router-exclude-mode": "boolean",
"group-info": {
"uptime": "integer",
"older-host-version1-timer": "integer",
"row-status": "string",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-added": "boolean",
"older-host-version2-timer": "integer",
"last-reporter": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"expiration-time": "string",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-suppressed": "boolean",
"is-self-join": "boolean",
"is-low-memory": "boolean",
"interface-name-xr": "string",
"router-filter-mode": "integer",
"explicit-tracking-enabled": "boolean"
},
"is-host-exclude-mode": "boolean"
}
]
}
DETAIL-GROUP - Retrieve
Retrieve operation of resource: detail-group
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"source": [
{
"uptime": "integer",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"expiration-time": "string",
"is-local": "boolean",
"is-forward": "boolean",
"is-added": "boolean",
"flags": "string",
"is-remote": "boolean",
"is-we-report": "boolean"
}
],
"is-router-exclude-mode": "boolean",
"group-info": {
"uptime": "integer",
"older-host-version1-timer": "integer",
"row-status": "string",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-added": "boolean",
"older-host-version2-timer": "integer",
"last-reporter": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"expiration-time": "string",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-suppressed": "boolean",
"is-self-join": "boolean",
"is-low-memory": "boolean",
"interface-name-xr": "string",
"router-filter-mode": "integer",
"explicit-tracking-enabled": "boolean"
},
"is-host-exclude-mode": "boolean"
}
GROUP-INFO - Retrieve
Retrieve operation of resource: group-info
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"uptime": "integer",
"older-host-version1-timer": "integer",
"row-status": "string",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-added": "boolean",
"older-host-version2-timer": "integer",
"last-reporter": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"expiration-time": "string",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-suppressed": "boolean",
"is-self-join": "boolean",
"is-low-memory": "boolean",
"interface-name-xr": "string",
"router-filter-mode": "integer",
"explicit-tracking-enabled": "boolean"
}
GROUP-ADDRESS-XR - Retrieve
Retrieve operation of resource: group-address-xr
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
LAST-REPORTER - Retrieve
Retrieve operation of resource: last-reporter
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SOURCE-ADDRESS - Retrieve
Retrieve operation of resource: source-address
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SOURCE - Retrieve
Retrieve operation of resource: source
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"uptime": "integer",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"expiration-time": "string",
"is-local": "boolean",
"is-forward": "boolean",
"is-added": "boolean",
"flags": "string",
"is-remote": "boolean",
"is-we-report": "boolean"
}
SOURCE-ADDRESS - Retrieve
Retrieve operation of resource: source-address
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
NON-ACTIVE-GROUPS - Retrieve
Retrieve operation of resource: non-active-groups
vrf-name
in path
string
ID of vrf-name
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"non-active-groups": [
{
"interface": "string",
"group-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"reason-for-non-activity": "string",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
}
NON-ACTIVE-GROUPS - Retrieve
Retrieve operation of resource: non-active-groups
vrf-name
in path
string
ID of vrf-name
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface": "string",
"group-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"reason-for-non-activity": "string",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
GROUP-ADDRESS - Retrieve
Retrieve operation of resource: group-address
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SOURCE-ADDRESS - Retrieve
Retrieve operation of resource: source-address
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SSM-MAPS - Retrieve
Retrieve operation of resource: ssm-maps
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ssm-map": [
{
"source-counts": "integer",
"map-type": "integer",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
}
SSM-MAP - Retrieve
Retrieve operation of resource: ssm-map
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"source-counts": "integer",
"map-type": "integer",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
GROUP-ADDRESS-XR - Retrieve
Retrieve operation of resource: group-address-xr
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
EXPLICIT-GROUPS - Retrieve
Retrieve operation of resource: explicit-groups
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"explicit-group": [
{
"exclude-hosts": "integer",
"host": [
{
"uptime": "integer",
"source-address": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"is-exclude": "boolean",
"expiration-time": "integer",
"source-count": "integer",
"address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
],
"include-hosts": "integer",
"group-info": {
"uptime": "integer",
"older-host-version1-timer": "integer",
"row-status": "string",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-added": "boolean",
"older-host-version2-timer": "integer",
"last-reporter": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"expiration-time": "string",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-suppressed": "boolean",
"is-self-join": "boolean",
"is-low-memory": "boolean",
"interface-name-xr": "string",
"router-filter-mode": "integer",
"explicit-tracking-enabled": "boolean"
}
}
]
}
EXPLICIT-GROUP - Retrieve
Retrieve operation of resource: explicit-group
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"exclude-hosts": "integer",
"host": [
{
"uptime": "integer",
"source-address": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"is-exclude": "boolean",
"expiration-time": "integer",
"source-count": "integer",
"address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
],
"include-hosts": "integer",
"group-info": {
"uptime": "integer",
"older-host-version1-timer": "integer",
"row-status": "string",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-added": "boolean",
"older-host-version2-timer": "integer",
"last-reporter": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"expiration-time": "string",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-suppressed": "boolean",
"is-self-join": "boolean",
"is-low-memory": "boolean",
"interface-name-xr": "string",
"router-filter-mode": "integer",
"explicit-tracking-enabled": "boolean"
}
}
GROUP-INFO - Retrieve
Retrieve operation of resource: group-info
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"uptime": "integer",
"older-host-version1-timer": "integer",
"row-status": "string",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-added": "boolean",
"older-host-version2-timer": "integer",
"last-reporter": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"expiration-time": "string",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-suppressed": "boolean",
"is-self-join": "boolean",
"is-low-memory": "boolean",
"interface-name-xr": "string",
"router-filter-mode": "integer",
"explicit-tracking-enabled": "boolean"
}
GROUP-ADDRESS-XR - Retrieve
Retrieve operation of resource: group-address-xr
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
LAST-REPORTER - Retrieve
Retrieve operation of resource: last-reporter
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SOURCE-ADDRESS - Retrieve
Retrieve operation of resource: source-address
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
HOST - Retrieve
Retrieve operation of resource: host
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"uptime": "integer",
"source-address": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"is-exclude": "boolean",
"expiration-time": "integer",
"source-count": "integer",
"address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
ADDRESS - Retrieve
Retrieve operation of resource: address
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SOURCE-ADDRESS - Retrieve
Retrieve operation of resource: source-address
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
INTERFACE-TABLE - Retrieve
Retrieve operation of resource: interface-table
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface": [
{
"interface-name": "string",
"las-ll-remove-update-count": "integer",
"las-ll-add-update-count": "integer",
"las-update-count": "integer",
"configurationvrf-set": "boolean",
"vrf-id": "integer",
"subscriber-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"vrf-state": "integer",
"last-member-query-interval": "integer",
"interface-name-xr": "string",
"is-las-registered": "boolean",
"group-leaves": "integer",
"is-router-enabled": "boolean",
"las-get-address-count": "integer",
"subscriber-mode": "integer",
"total-active-groups": "integer",
"configuration-mcast-vrf-set": "boolean",
"querier-uptime": "integer",
"proxy-interface": "string",
"is-subscriber": "boolean",
"mte-vrf-id": "integer",
"state": "string",
"time-since-last-query-in-seconds": "integer",
"location": "integer",
"subscriber-id": "string",
"is-ip-enabled": "boolean",
"router-uptime-in-seconds": "integer",
"parent-ifhandle": "string",
"query-interval": "integer",
"configuration-mcast-vrf-error": "boolean",
"is-identity-present": "boolean",
"query-timeout": "integer",
"query-maximum-response-time": "integer",
"querier-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"igmp-version": "integer",
"las-ll-registration-count": "integer",
"is-interface-up": "boolean",
"mte-tuple-count": "integer",
"is-las-request": "boolean",
"prefix-length": "integer",
"las-null-update-count": "integer",
"is-querier": "boolean",
"robustness": "integer",
"las-unregistration-count": "integer",
"is-im-state-registered": "boolean",
"mtu": "integer",
"is-configurationverify": "boolean",
"time-since-last-report-in-seconds": "integer",
"configurationvrf-error": "boolean",
"host-version": "integer",
"group-joins": "integer"
}
]
}
INTERFACE - Retrieve
Retrieve operation of resource: interface
vrf-name
in path
string
ID of vrf-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"las-ll-remove-update-count": "integer",
"las-ll-add-update-count": "integer",
"las-update-count": "integer",
"configurationvrf-set": "boolean",
"vrf-id": "integer",
"subscriber-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"vrf-state": "integer",
"last-member-query-interval": "integer",
"interface-name-xr": "string",
"is-las-registered": "boolean",
"group-leaves": "integer",
"is-router-enabled": "boolean",
"las-get-address-count": "integer",
"subscriber-mode": "integer",
"total-active-groups": "integer",
"configuration-mcast-vrf-set": "boolean",
"querier-uptime": "integer",
"proxy-interface": "string",
"is-subscriber": "boolean",
"mte-vrf-id": "integer",
"state": "string",
"time-since-last-query-in-seconds": "integer",
"location": "integer",
"subscriber-id": "string",
"is-ip-enabled": "boolean",
"router-uptime-in-seconds": "integer",
"parent-ifhandle": "string",
"query-interval": "integer",
"configuration-mcast-vrf-error": "boolean",
"is-identity-present": "boolean",
"query-timeout": "integer",
"query-maximum-response-time": "integer",
"querier-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"igmp-version": "integer",
"las-ll-registration-count": "integer",
"is-interface-up": "boolean",
"mte-tuple-count": "integer",
"is-las-request": "boolean",
"prefix-length": "integer",
"las-null-update-count": "integer",
"is-querier": "boolean",
"robustness": "integer",
"las-unregistration-count": "integer",
"is-im-state-registered": "boolean",
"mtu": "integer",
"is-configurationverify": "boolean",
"time-since-last-report-in-seconds": "integer",
"configurationvrf-error": "boolean",
"host-version": "integer",
"group-joins": "integer"
}
ADDRESS - Retrieve
Retrieve operation of resource: address
vrf-name
in path
string
ID of vrf-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
QUERIER-ADDRESS - Retrieve
Retrieve operation of resource: querier-address
vrf-name
in path
string
ID of vrf-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SUBSCRIBER-ADDRESS - Retrieve
Retrieve operation of resource: subscriber-address
vrf-name
in path
string
ID of vrf-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
INTERFACE-UNICAST-QOS-ADJUSTS - Retrieve
Retrieve operation of resource: interface-unicast-qos-adjusts
vrf-name
in path
string
ID of vrf-name
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-unicast-qos-adjust": [
{
"is-virtual-access": "boolean",
"rate": "integer",
"rate-increments": "integer",
"rate-decrements": "integer",
"update": [
{
"is-add": "boolean",
"group-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"received-time": "integer",
"weight": "integer",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
}
]
}
INTERFACE-UNICAST-QOS-ADJUST - Retrieve
Retrieve operation of resource: interface-unicast-qos-adjust
vrf-name
in path
string
ID of vrf-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-virtual-access": "boolean",
"rate": "integer",
"rate-increments": "integer",
"rate-decrements": "integer",
"update": [
{
"is-add": "boolean",
"group-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"received-time": "integer",
"weight": "integer",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
}
UPDATE - Retrieve
Retrieve operation of resource: update
vrf-name
in path
string
ID of vrf-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-add": "boolean",
"group-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"received-time": "integer",
"weight": "integer",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
SOURCE-ADDRESS - Retrieve
Retrieve operation of resource: source-address
vrf-name
in path
string
ID of vrf-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
GROUP-ADDRESS - Retrieve
Retrieve operation of resource: group-address
vrf-name
in path
string
ID of vrf-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
RANGES - Retrieve
Retrieve operation of resource: ranges
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"range": [
{
"is-stale": "boolean",
"protocol": "string",
"prefix-length": "integer",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
}
RANGE - Retrieve
Retrieve operation of resource: range
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-stale": "boolean",
"protocol": "string",
"prefix-length": "integer",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
GROUP-ADDRESS-XR - Retrieve
Retrieve operation of resource: group-address-xr
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
IFRS-INTERFACES - Retrieve
Retrieve operation of resource: ifrs-interfaces
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ifrs-interface": [
{
"join-group-count": "integer",
"igmp-interface-entry": {
"las-ll-remove-update-count": "integer",
"las-ll-add-update-count": "integer",
"las-update-count": "integer",
"configurationvrf-set": "boolean",
"vrf-id": "integer",
"subscriber-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"vrf-state": "integer",
"last-member-query-interval": "integer",
"interface-name-xr": "string",
"is-las-registered": "boolean",
"group-leaves": "integer",
"is-router-enabled": "boolean",
"las-get-address-count": "integer",
"subscriber-mode": "integer",
"total-active-groups": "integer",
"configuration-mcast-vrf-set": "boolean",
"querier-uptime": "integer",
"proxy-interface": "string",
"is-subscriber": "boolean",
"mte-vrf-id": "integer",
"state": "string",
"time-since-last-query-in-seconds": "integer",
"location": "integer",
"subscriber-id": "string",
"is-ip-enabled": "boolean",
"router-uptime-in-seconds": "integer",
"parent-ifhandle": "string",
"query-interval": "integer",
"configuration-mcast-vrf-error": "boolean",
"is-identity-present": "boolean",
"query-timeout": "integer",
"query-maximum-response-time": "integer",
"querier-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"igmp-version": "integer",
"las-ll-registration-count": "integer",
"is-interface-up": "boolean",
"mte-tuple-count": "integer",
"is-las-request": "boolean",
"prefix-length": "integer",
"las-null-update-count": "integer",
"is-querier": "boolean",
"robustness": "integer",
"las-unregistration-count": "integer",
"is-im-state-registered": "boolean",
"mtu": "integer",
"is-configurationverify": "boolean",
"time-since-last-report-in-seconds": "integer",
"configurationvrf-error": "boolean",
"host-version": "integer",
"group-joins": "integer"
}
}
]
}
IFRS-INTERFACE - Retrieve
Retrieve operation of resource: ifrs-interface
vrf-name
in path
string
ID of vrf-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"join-group-count": "integer",
"igmp-interface-entry": {
"las-ll-remove-update-count": "integer",
"las-ll-add-update-count": "integer",
"las-update-count": "integer",
"configurationvrf-set": "boolean",
"vrf-id": "integer",
"subscriber-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"vrf-state": "integer",
"last-member-query-interval": "integer",
"interface-name-xr": "string",
"is-las-registered": "boolean",
"group-leaves": "integer",
"is-router-enabled": "boolean",
"las-get-address-count": "integer",
"subscriber-mode": "integer",
"total-active-groups": "integer",
"configuration-mcast-vrf-set": "boolean",
"querier-uptime": "integer",
"proxy-interface": "string",
"is-subscriber": "boolean",
"mte-vrf-id": "integer",
"state": "string",
"time-since-last-query-in-seconds": "integer",
"location": "integer",
"subscriber-id": "string",
"is-ip-enabled": "boolean",
"router-uptime-in-seconds": "integer",
"parent-ifhandle": "string",
"query-interval": "integer",
"configuration-mcast-vrf-error": "boolean",
"is-identity-present": "boolean",
"query-timeout": "integer",
"query-maximum-response-time": "integer",
"querier-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"igmp-version": "integer",
"las-ll-registration-count": "integer",
"is-interface-up": "boolean",
"mte-tuple-count": "integer",
"is-las-request": "boolean",
"prefix-length": "integer",
"las-null-update-count": "integer",
"is-querier": "boolean",
"robustness": "integer",
"las-unregistration-count": "integer",
"is-im-state-registered": "boolean",
"mtu": "integer",
"is-configurationverify": "boolean",
"time-since-last-report-in-seconds": "integer",
"configurationvrf-error": "boolean",
"host-version": "integer",
"group-joins": "integer"
}
}
IGMP-INTERFACE-ENTRY - Retrieve
Retrieve operation of resource: igmp-interface-entry
vrf-name
in path
string
ID of vrf-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"las-ll-remove-update-count": "integer",
"las-ll-add-update-count": "integer",
"las-update-count": "integer",
"configurationvrf-set": "boolean",
"vrf-id": "integer",
"subscriber-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"vrf-state": "integer",
"last-member-query-interval": "integer",
"interface-name-xr": "string",
"is-las-registered": "boolean",
"group-leaves": "integer",
"is-router-enabled": "boolean",
"las-get-address-count": "integer",
"subscriber-mode": "integer",
"total-active-groups": "integer",
"configuration-mcast-vrf-set": "boolean",
"querier-uptime": "integer",
"proxy-interface": "string",
"is-subscriber": "boolean",
"mte-vrf-id": "integer",
"state": "string",
"time-since-last-query-in-seconds": "integer",
"location": "integer",
"subscriber-id": "string",
"is-ip-enabled": "boolean",
"router-uptime-in-seconds": "integer",
"parent-ifhandle": "string",
"query-interval": "integer",
"configuration-mcast-vrf-error": "boolean",
"is-identity-present": "boolean",
"query-timeout": "integer",
"query-maximum-response-time": "integer",
"querier-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"igmp-version": "integer",
"las-ll-registration-count": "integer",
"is-interface-up": "boolean",
"mte-tuple-count": "integer",
"is-las-request": "boolean",
"prefix-length": "integer",
"las-null-update-count": "integer",
"is-querier": "boolean",
"robustness": "integer",
"las-unregistration-count": "integer",
"is-im-state-registered": "boolean",
"mtu": "integer",
"is-configurationverify": "boolean",
"time-since-last-report-in-seconds": "integer",
"configurationvrf-error": "boolean",
"host-version": "integer",
"group-joins": "integer"
}
ADDRESS - Retrieve
Retrieve operation of resource: address
vrf-name
in path
string
ID of vrf-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
QUERIER-ADDRESS - Retrieve
Retrieve operation of resource: querier-address
vrf-name
in path
string
ID of vrf-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SUBSCRIBER-ADDRESS - Retrieve
Retrieve operation of resource: subscriber-address
vrf-name
in path
string
ID of vrf-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
TRAFFIC-COUNTERS - Retrieve
Retrieve operation of resource: traffic-counters
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"checksum-errors": "integer",
"auxillary-data-length-errors": "integer",
"input-mtrace": "integer",
"socket-errors": "integer",
"packet-manager-input-errors": "integer",
"packets-out": "integer",
"input-no-idb": "integer",
"output-no-parent-interface-handle": "integer",
"receive-socket-errors": "integer",
"output-leaves": "integer",
"no-socket-connection": "integer",
"bad-scope-errors": "integer",
"input-leaves": "integer",
"invalid-source-address-errors": "integer",
"get-packet-failure": "integer",
"input-dvmrp": "integer",
"miscellaneous-errors": "integer",
"elapsed-time": "integer",
"input-no-platform-support-mtrace": "integer",
"input-queries": "integer",
"output-pim": "integer",
"input-disabled-idb": "integer",
"packet-manager-output-errors": "integer",
"format-errors": "integer",
"packets-in": "integer",
"input-no-vrf-mtrace": "integer",
"input-no-assigned-vrf-id": "integer",
"input-reports": "integer",
"input-pim": "integer",
"input-martian-address": "integer",
"output-queries": "integer",
"input-no-vrf-in-idb": "integer",
"output-mtrace": "integer",
"output-reports": "integer",
"output-dvmrp": "integer"
}
GROUPS - Retrieve
Retrieve operation of resource: groups
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"group": [
{
"uptime": "integer",
"older-host-version1-timer": "integer",
"row-status": "string",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-added": "boolean",
"older-host-version2-timer": "integer",
"last-reporter": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"expiration-time": "string",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-suppressed": "boolean",
"is-self-join": "boolean",
"is-low-memory": "boolean",
"interface-name-xr": "string",
"router-filter-mode": "integer",
"explicit-tracking-enabled": "boolean"
}
]
}
GROUP - Retrieve
Retrieve operation of resource: group
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"uptime": "integer",
"older-host-version1-timer": "integer",
"row-status": "string",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-added": "boolean",
"older-host-version2-timer": "integer",
"last-reporter": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"expiration-time": "string",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-suppressed": "boolean",
"is-self-join": "boolean",
"is-low-memory": "boolean",
"interface-name-xr": "string",
"router-filter-mode": "integer",
"explicit-tracking-enabled": "boolean"
}
GROUP-ADDRESS-XR - Retrieve
Retrieve operation of resource: group-address-xr
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
LAST-REPORTER - Retrieve
Retrieve operation of resource: last-reporter
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SOURCE-ADDRESS - Retrieve
Retrieve operation of resource: source-address
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
GROUP-SUMMARY - Retrieve
Retrieve operation of resource: group-summary
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"group-count": "integer",
"groutes": "integer",
"sg-routes": "integer",
"is-low-memory": "boolean"
}
IFRS-INTERFACE-SUMMARY - Retrieve
Retrieve operation of resource: ifrs-interface-summary
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-count": "integer",
"configuration-count": "integer"
}
GLOBAL-INTERFACE-TABLE - Retrieve
Retrieve operation of resource: global-interface-table
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface": [
{
"interface-name": "string",
"las-ll-remove-update-count": "integer",
"las-ll-add-update-count": "integer",
"las-update-count": "integer",
"configurationvrf-set": "boolean",
"vrf-id": "integer",
"subscriber-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"vrf-state": "integer",
"last-member-query-interval": "integer",
"interface-name-xr": "string",
"is-las-registered": "boolean",
"group-leaves": "integer",
"is-router-enabled": "boolean",
"las-get-address-count": "integer",
"subscriber-mode": "integer",
"total-active-groups": "integer",
"configuration-mcast-vrf-set": "boolean",
"querier-uptime": "integer",
"proxy-interface": "string",
"is-subscriber": "boolean",
"mte-vrf-id": "integer",
"state": "string",
"time-since-last-query-in-seconds": "integer",
"location": "integer",
"subscriber-id": "string",
"is-ip-enabled": "boolean",
"router-uptime-in-seconds": "integer",
"parent-ifhandle": "string",
"query-interval": "integer",
"configuration-mcast-vrf-error": "boolean",
"is-identity-present": "boolean",
"query-timeout": "integer",
"query-maximum-response-time": "integer",
"querier-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"igmp-version": "integer",
"las-ll-registration-count": "integer",
"is-interface-up": "boolean",
"mte-tuple-count": "integer",
"is-las-request": "boolean",
"prefix-length": "integer",
"las-null-update-count": "integer",
"is-querier": "boolean",
"robustness": "integer",
"las-unregistration-count": "integer",
"is-im-state-registered": "boolean",
"mtu": "integer",
"is-configurationverify": "boolean",
"time-since-last-report-in-seconds": "integer",
"configurationvrf-error": "boolean",
"host-version": "integer",
"group-joins": "integer"
}
]
}
INTERFACE - Retrieve
Retrieve operation of resource: interface
vrf-name
in path
string
ID of vrf-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"las-ll-remove-update-count": "integer",
"las-ll-add-update-count": "integer",
"las-update-count": "integer",
"configurationvrf-set": "boolean",
"vrf-id": "integer",
"subscriber-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"vrf-state": "integer",
"last-member-query-interval": "integer",
"interface-name-xr": "string",
"is-las-registered": "boolean",
"group-leaves": "integer",
"is-router-enabled": "boolean",
"las-get-address-count": "integer",
"subscriber-mode": "integer",
"total-active-groups": "integer",
"configuration-mcast-vrf-set": "boolean",
"querier-uptime": "integer",
"proxy-interface": "string",
"is-subscriber": "boolean",
"mte-vrf-id": "integer",
"state": "string",
"time-since-last-query-in-seconds": "integer",
"location": "integer",
"subscriber-id": "string",
"is-ip-enabled": "boolean",
"router-uptime-in-seconds": "integer",
"parent-ifhandle": "string",
"query-interval": "integer",
"configuration-mcast-vrf-error": "boolean",
"is-identity-present": "boolean",
"query-timeout": "integer",
"query-maximum-response-time": "integer",
"querier-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"igmp-version": "integer",
"las-ll-registration-count": "integer",
"is-interface-up": "boolean",
"mte-tuple-count": "integer",
"is-las-request": "boolean",
"prefix-length": "integer",
"las-null-update-count": "integer",
"is-querier": "boolean",
"robustness": "integer",
"las-unregistration-count": "integer",
"is-im-state-registered": "boolean",
"mtu": "integer",
"is-configurationverify": "boolean",
"time-since-last-report-in-seconds": "integer",
"configurationvrf-error": "boolean",
"host-version": "integer",
"group-joins": "integer"
}
ADDRESS - Retrieve
Retrieve operation of resource: address
vrf-name
in path
string
ID of vrf-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
QUERIER-ADDRESS - Retrieve
Retrieve operation of resource: querier-address
vrf-name
in path
string
ID of vrf-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SUBSCRIBER-ADDRESS - Retrieve
Retrieve operation of resource: subscriber-address
vrf-name
in path
string
ID of vrf-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SSM-MAP-DETAILS - Retrieve
Retrieve operation of resource: ssm-map-details
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ssm-map-detail": [
{
"response-pending": "boolean",
"query-interval": "integer",
"map-info": {
"source-counts": "integer",
"map-type": "integer",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
},
"expiration-time": "integer",
"sources": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"elapsed-time": "integer"
}
]
}
SSM-MAP-DETAIL - Retrieve
Retrieve operation of resource: ssm-map-detail
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"response-pending": "boolean",
"query-interval": "integer",
"map-info": {
"source-counts": "integer",
"map-type": "integer",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
},
"expiration-time": "integer",
"sources": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"elapsed-time": "integer"
}
MAP-INFO - Retrieve
Retrieve operation of resource: map-info
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"source-counts": "integer",
"map-type": "integer",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
GROUP-ADDRESS-XR - Retrieve
Retrieve operation of resource: group-address-xr
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SOURCES - Retrieve
Retrieve operation of resource: sources
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
INTERFACE-STATE-OFFS - Retrieve
Retrieve operation of resource: interface-state-offs
vrf-name
in path
string
ID of vrf-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-state-off": [
{
"las-ll-remove-update-count": "integer",
"las-ll-add-update-count": "integer",
"las-update-count": "integer",
"configurationvrf-set": "boolean",
"vrf-id": "integer",
"subscriber-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"vrf-state": "integer",
"last-member-query-interval": "integer",
"interface-name-xr": "string",
"is-las-registered": "boolean",
"group-leaves": "integer",
"is-router-enabled": "boolean",
"las-get-address-count": "integer",
"subscriber-mode": "integer",
"total-active-groups": "integer",
"configuration-mcast-vrf-set": "boolean",
"querier-uptime": "integer",
"proxy-interface": "string",
"is-subscriber": "boolean",
"mte-vrf-id": "integer",
"state": "string",
"time-since-last-query-in-seconds": "integer",
"location": "integer",
"subscriber-id": "string",
"is-ip-enabled": "boolean",
"router-uptime-in-seconds": "integer",
"parent-ifhandle": "string",
"query-interval": "integer",
"configuration-mcast-vrf-error": "boolean",
"is-identity-present": "boolean",
"query-timeout": "integer",
"query-maximum-response-time": "integer",
"querier-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"igmp-version": "integer",
"las-ll-registration-count": "integer",
"is-interface-up": "boolean",
"mte-tuple-count": "integer",
"is-las-request": "boolean",
"prefix-length": "integer",
"las-null-update-count": "integer",
"is-querier": "boolean",
"robustness": "integer",
"las-unregistration-count": "integer",
"is-im-state-registered": "boolean",
"mtu": "integer",
"is-configurationverify": "boolean",
"time-since-last-report-in-seconds": "integer",
"configurationvrf-error": "boolean",
"host-version": "integer",
"group-joins": "integer"
}
]
}
INTERFACE-STATE-OFF - Retrieve
Retrieve operation of resource: interface-state-off
vrf-name
in path
string
ID of vrf-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"las-ll-remove-update-count": "integer",
"las-ll-add-update-count": "integer",
"las-update-count": "integer",
"configurationvrf-set": "boolean",
"vrf-id": "integer",
"subscriber-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"vrf-state": "integer",
"last-member-query-interval": "integer",
"interface-name-xr": "string",
"is-las-registered": "boolean",
"group-leaves": "integer",
"is-router-enabled": "boolean",
"las-get-address-count": "integer",
"subscriber-mode": "integer",
"total-active-groups": "integer",
"configuration-mcast-vrf-set": "boolean",
"querier-uptime": "integer",
"proxy-interface": "string",
"is-subscriber": "boolean",
"mte-vrf-id": "integer",
"state": "string",
"time-since-last-query-in-seconds": "integer",
"location": "integer",
"subscriber-id": "string",
"is-ip-enabled": "boolean",
"router-uptime-in-seconds": "integer",
"parent-ifhandle": "string",
"query-interval": "integer",
"configuration-mcast-vrf-error": "boolean",
"is-identity-present": "boolean",
"query-timeout": "integer",
"query-maximum-response-time": "integer",
"querier-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"igmp-version": "integer",
"las-ll-registration-count": "integer",
"is-interface-up": "boolean",
"mte-tuple-count": "integer",
"is-las-request": "boolean",
"prefix-length": "integer",
"las-null-update-count": "integer",
"is-querier": "boolean",
"robustness": "integer",
"las-unregistration-count": "integer",
"is-im-state-registered": "boolean",
"mtu": "integer",
"is-configurationverify": "boolean",
"time-since-last-report-in-seconds": "integer",
"configurationvrf-error": "boolean",
"host-version": "integer",
"group-joins": "integer"
}
ADDRESS - Retrieve
Retrieve operation of resource: address
vrf-name
in path
string
ID of vrf-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
QUERIER-ADDRESS - Retrieve
Retrieve operation of resource: querier-address
vrf-name
in path
string
ID of vrf-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SUBSCRIBER-ADDRESS - Retrieve
Retrieve operation of resource: subscriber-address
vrf-name
in path
string
ID of vrf-name
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
PROCESS - Retrieve
Retrieve operation of resource: process
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"amt-gateways": {
"amt-gateway": [
{
"amt-nonce": "integer",
"amtgw": "string",
"mem-upd-in": "integer",
"key-len": "integer",
"mem-upd-out": "integer",
"amtnh": "integer",
"amt-port": "integer",
"idb": "integer"
}
]
},
"unicast-qos-adjust-stats": {
"is-qos-s-sweeped": "boolean",
"batches": "integer",
"send-errors": "integer",
"last-download-time": "integer",
"sent-resync-bulks": "integer",
"is-resync-required": "boolean",
"queues": "integer",
"is-resync-start-sent": "boolean",
"send-partial-errors": "integer",
"last-sweep-time": "integer",
"send-success": "integer",
"is-resync-received": "boolean",
"add-to-batches": "integer",
"received-resync-requests": "integer",
"send-comm-errors": "integer",
"delete-to-batches": "integer"
},
"amt-summary": {
"gateway-count": "integer",
"prefix-length": "integer",
"anycast-prefix": "string",
"query-interval": "integer",
"relay-address": "string",
"tos": "integer",
"mtu": "integer",
"tunnel-count": "integer",
"tunnel-configured-maximum": "integer",
"ttl": "integer",
"is-acl-configured": "boolean",
"max-gateway": "integer",
"is-gateway-simulation": "boolean",
"is-ou-of-resource": "boolean"
},
"nsf": {
"last-nsf-off": "string",
"last-icd-notif-recv-min": "string",
"multicast-nsf-time-left": "integer",
"is-multicast-nsf-active": "boolean",
"last-icd-notif-recv": "string",
"multicast-nsf-timeout": "integer",
"respawn-count": "integer",
"last-nsf-on-min": "string",
"last-nsf-on": "string",
"last-nsf-off-min": "string"
},
"bvi-statistics": {
"tx-unknown-mrouter-msg": "integer",
"send-blocks": "integer",
"tx-protocol-buffers": "integer",
"rx-ipc-close-notif": "integer",
"rx-ipc-publish-notif": "integer",
"wtx-msg-proto-sent": "integer",
"rx-igmp-packet-success": "integer",
"rx-ipc-open-notif": "integer",
"rx-sweep-mrouter-msg": "integer",
"rx-ipc-lwm-notif": "integer",
"wtx-msg-drop-nomem": "integer",
"rx-delete-mrouter-msg": "integer",
"wtx-msg-freed": "integer",
"rx-ipc-q-full-notif": "integer",
"receive-buffers": "integer",
"rx-add-mrouter-msg": "integer",
"tx-add-mrouter-msg": "integer",
"rx-ipc-input-wait-notif": "integer",
"tx-sweep-mrouter-msg": "integer",
"tx-unknown-buffers": "integer",
"rx-ipc-send-status-notif": "integer",
"rx-ipc-output-notif": "integer",
"wtx-msg-drop-dc": "integer",
"null-buffer-handles": "integer",
"tx-delete-mrouter-msg": "integer",
"rx-ipc-error-notif": "integer",
"rx-unknown-mrouter-msg": "integer",
"release-buffers": "integer",
"release-fail-buffers": "integer",
"tx-buffer-errors": "integer",
"tx-mrouter-buffers": "integer",
"tx-buffers": "integer",
"wtx-msg-recvd": "integer",
"wtx-msg-sent": "integer",
"rx-ipc-connect-notif": "integer"
},
"nsr": {
"collab-conv-done": "boolean"
}
}
AMT-SUMMARY - Retrieve
Retrieve operation of resource: amt-summary
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"gateway-count": "integer",
"prefix-length": "integer",
"anycast-prefix": "string",
"query-interval": "integer",
"relay-address": "string",
"tos": "integer",
"mtu": "integer",
"tunnel-count": "integer",
"tunnel-configured-maximum": "integer",
"ttl": "integer",
"is-acl-configured": "boolean",
"max-gateway": "integer",
"is-gateway-simulation": "boolean",
"is-ou-of-resource": "boolean"
}
NSR - Retrieve
Retrieve operation of resource: nsr
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"collab-conv-done": "boolean",
"rmf-notification-done": "boolean",
"last-rmf-not-ready": "integer",
"count-proc-connection-dn": "integer",
"count-rmf-ready": "integer",
"state": "integer",
"count-proc-connection-up": "integer",
"last-proc": "integer",
"count-rmf-not-ready": "integer",
"last-proc-connection-up": "integer",
"last-proc-connection-dn": "integer",
"last-rmf-ready": "integer",
"partner-proc-connected": "boolean"
}
AMT-GATEWAYS - Retrieve
Retrieve operation of resource: amt-gateways
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"amt-gateway": [
{
"amt-nonce": "integer",
"amtgw": "string",
"mem-upd-in": "integer",
"key-len": "integer",
"mem-upd-out": "integer",
"amtnh": "integer",
"amt-port": "integer",
"idb": "integer"
}
]
}
AMT-GATEWAY - Retrieve
Retrieve operation of resource: amt-gateway
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"amt-nonce": "integer",
"amtgw": "string",
"mem-upd-in": "integer",
"key-len": "integer",
"mem-upd-out": "integer",
"amtnh": "integer",
"amt-port": "integer",
"idb": "integer"
}
UNICAST-QOS-ADJUST-STATS - Retrieve
Retrieve operation of resource: unicast-qos-adjust-stats
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-qos-s-sweeped": "boolean",
"batches": "integer",
"send-errors": "integer",
"last-download-time": "integer",
"sent-resync-bulks": "integer",
"is-resync-required": "boolean",
"queues": "integer",
"is-resync-start-sent": "boolean",
"send-partial-errors": "integer",
"last-sweep-time": "integer",
"send-success": "integer",
"is-resync-received": "boolean",
"add-to-batches": "integer",
"received-resync-requests": "integer",
"send-comm-errors": "integer",
"delete-to-batches": "integer"
}
BVI-STATISTICS - Retrieve
Retrieve operation of resource: bvi-statistics
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"tx-unknown-mrouter-msg": "integer",
"send-blocks": "integer",
"tx-protocol-buffers": "integer",
"rx-ipc-close-notif": "integer",
"rx-ipc-publish-notif": "integer",
"wtx-msg-proto-sent": "integer",
"rx-igmp-packet-success": "integer",
"rx-ipc-open-notif": "integer",
"rx-sweep-mrouter-msg": "integer",
"rx-ipc-lwm-notif": "integer",
"wtx-msg-drop-nomem": "integer",
"rx-delete-mrouter-msg": "integer",
"wtx-msg-freed": "integer",
"rx-ipc-q-full-notif": "integer",
"receive-buffers": "integer",
"rx-add-mrouter-msg": "integer",
"tx-add-mrouter-msg": "integer",
"rx-ipc-input-wait-notif": "integer",
"tx-sweep-mrouter-msg": "integer",
"tx-unknown-buffers": "integer",
"rx-ipc-send-status-notif": "integer",
"rx-ipc-output-notif": "integer",
"wtx-msg-drop-dc": "integer",
"null-buffer-handles": "integer",
"tx-delete-mrouter-msg": "integer",
"rx-ipc-error-notif": "integer",
"rx-unknown-mrouter-msg": "integer",
"release-buffers": "integer",
"release-fail-buffers": "integer",
"tx-buffer-errors": "integer",
"tx-mrouter-buffers": "integer",
"tx-buffers": "integer",
"wtx-msg-recvd": "integer",
"wtx-msg-sent": "integer",
"rx-ipc-connect-notif": "integer"
}
NSF - Retrieve
Retrieve operation of resource: nsf
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"last-nsf-off": "string",
"last-icd-notif-recv-min": "string",
"multicast-nsf-time-left": "integer",
"is-multicast-nsf-active": "boolean",
"last-icd-notif-recv": "string",
"multicast-nsf-timeout": "integer",
"respawn-count": "integer",
"last-nsf-on-min": "string",
"last-nsf-on": "string",
"last-nsf-off-min": "string"
}
DEFAULT-CONTEXT - Retrieve
Retrieve operation of resource: default-context
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-state-offs": {
"interface-state-off": [
{
"interface-name": "string",
"las-ll-remove-update-count": "integer",
"las-ll-add-update-count": "integer",
"las-update-count": "integer",
"configurationvrf-set": "boolean",
"vrf-id": "integer",
"subscriber-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"vrf-state": "integer",
"last-member-query-interval": "integer",
"interface-name-xr": "string",
"is-las-registered": "boolean",
"group-leaves": "integer",
"is-router-enabled": "boolean",
"las-get-address-count": "integer",
"subscriber-mode": "integer",
"total-active-groups": "integer",
"configuration-mcast-vrf-set": "boolean",
"querier-uptime": "integer",
"proxy-interface": "string",
"is-subscriber": "boolean",
"mte-vrf-id": "integer",
"state": "string",
"time-since-last-query-in-seconds": "integer",
"location": "integer",
"subscriber-id": "string",
"is-ip-enabled": "boolean",
"router-uptime-in-seconds": "integer",
"parent-ifhandle": "string",
"query-interval": "integer",
"configuration-mcast-vrf-error": "boolean",
"is-identity-present": "boolean",
"query-timeout": "integer",
"query-maximum-response-time": "integer",
"querier-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"igmp-version": "integer",
"las-ll-registration-count": "integer",
"is-interface-up": "boolean",
"mte-tuple-count": "integer",
"is-las-request": "boolean",
"prefix-length": "integer",
"las-null-update-count": "integer",
"is-querier": "boolean",
"robustness": "integer",
"las-unregistration-count": "integer",
"is-im-state-registered": "boolean",
"mtu": "integer",
"is-configurationverify": "boolean",
"time-since-last-report-in-seconds": "integer",
"configurationvrf-error": "boolean",
"host-version": "integer",
"group-joins": "integer"
}
]
}
}
SUMMARY - Retrieve
Retrieve operation of resource: summary
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"group-count": "integer",
"disabled-interface-count": "integer",
"group-limit": "integer",
"supported-interfaces": "integer",
"robustness": "integer",
"is-disabled": "boolean",
"enabled-interface-count": "integer",
"node-low-memory": "boolean",
"unsupported-interfaces": "integer",
"tunnel-mte-config-count": "integer",
"interface": [
{
"group-count": "integer",
"parent-ifhandle": "string",
"router-uptime-in-seconds": "integer",
"interface-name": "string",
"group-limit": "integer",
"on-off": "boolean",
"time-since-last-report-in-seconds": "integer",
"time-since-last-query-in-seconds": "integer"
}
]
}
INTERFACE - Retrieve
Retrieve operation of resource: interface
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"group-count": "integer",
"parent-ifhandle": "string",
"router-uptime-in-seconds": "integer",
"interface-name": "string",
"group-limit": "integer",
"on-off": "boolean",
"time-since-last-report-in-seconds": "integer",
"time-since-last-query-in-seconds": "integer"
}
INTERFACE-STATE-ONS - Retrieve
Retrieve operation of resource: interface-state-ons
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-state-on": [
{
"las-ll-remove-update-count": "integer",
"las-ll-add-update-count": "integer",
"las-update-count": "integer",
"configurationvrf-set": "boolean",
"vrf-id": "integer",
"subscriber-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"vrf-state": "integer",
"last-member-query-interval": "integer",
"interface-name-xr": "string",
"is-las-registered": "boolean",
"group-leaves": "integer",
"is-router-enabled": "boolean",
"las-get-address-count": "integer",
"subscriber-mode": "integer",
"total-active-groups": "integer",
"configuration-mcast-vrf-set": "boolean",
"querier-uptime": "integer",
"proxy-interface": "string",
"is-subscriber": "boolean",
"mte-vrf-id": "integer",
"state": "string",
"time-since-last-query-in-seconds": "integer",
"location": "integer",
"subscriber-id": "string",
"is-ip-enabled": "boolean",
"router-uptime-in-seconds": "integer",
"parent-ifhandle": "string",
"query-interval": "integer",
"configuration-mcast-vrf-error": "boolean",
"is-identity-present": "boolean",
"query-timeout": "integer",
"query-maximum-response-time": "integer",
"querier-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"igmp-version": "integer",
"las-ll-registration-count": "integer",
"is-interface-up": "boolean",
"mte-tuple-count": "integer",
"is-las-request": "boolean",
"prefix-length": "integer",
"las-null-update-count": "integer",
"is-querier": "boolean",
"robustness": "integer",
"las-unregistration-count": "integer",
"is-im-state-registered": "boolean",
"mtu": "integer",
"is-configurationverify": "boolean",
"time-since-last-report-in-seconds": "integer",
"configurationvrf-error": "boolean",
"host-version": "integer",
"group-joins": "integer"
}
]
}
INTERFACE-STATE-ON - Retrieve
Retrieve operation of resource: interface-state-on
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"las-ll-remove-update-count": "integer",
"las-ll-add-update-count": "integer",
"las-update-count": "integer",
"configurationvrf-set": "boolean",
"vrf-id": "integer",
"subscriber-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"vrf-state": "integer",
"last-member-query-interval": "integer",
"interface-name-xr": "string",
"is-las-registered": "boolean",
"group-leaves": "integer",
"is-router-enabled": "boolean",
"las-get-address-count": "integer",
"subscriber-mode": "integer",
"total-active-groups": "integer",
"configuration-mcast-vrf-set": "boolean",
"querier-uptime": "integer",
"proxy-interface": "string",
"is-subscriber": "boolean",
"mte-vrf-id": "integer",
"state": "string",
"time-since-last-query-in-seconds": "integer",
"location": "integer",
"subscriber-id": "string",
"is-ip-enabled": "boolean",
"router-uptime-in-seconds": "integer",
"parent-ifhandle": "string",
"query-interval": "integer",
"configuration-mcast-vrf-error": "boolean",
"is-identity-present": "boolean",
"query-timeout": "integer",
"query-maximum-response-time": "integer",
"querier-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"igmp-version": "integer",
"las-ll-registration-count": "integer",
"is-interface-up": "boolean",
"mte-tuple-count": "integer",
"is-las-request": "boolean",
"prefix-length": "integer",
"las-null-update-count": "integer",
"is-querier": "boolean",
"robustness": "integer",
"las-unregistration-count": "integer",
"is-im-state-registered": "boolean",
"mtu": "integer",
"is-configurationverify": "boolean",
"time-since-last-report-in-seconds": "integer",
"configurationvrf-error": "boolean",
"host-version": "integer",
"group-joins": "integer"
}
ADDRESS - Retrieve
Retrieve operation of resource: address
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
QUERIER-ADDRESS - Retrieve
Retrieve operation of resource: querier-address
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SUBSCRIBER-ADDRESS - Retrieve
Retrieve operation of resource: subscriber-address
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
DETAIL-GROUPS - Retrieve
Retrieve operation of resource: detail-groups
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"detail-group": [
{
"source": [
{
"uptime": "integer",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"expiration-time": "string",
"is-local": "boolean",
"is-forward": "boolean",
"is-added": "boolean",
"flags": "string",
"is-remote": "boolean",
"is-we-report": "boolean"
}
],
"is-router-exclude-mode": "boolean",
"group-info": {
"uptime": "integer",
"older-host-version1-timer": "integer",
"row-status": "string",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-added": "boolean",
"older-host-version2-timer": "integer",
"last-reporter": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"expiration-time": "string",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-suppressed": "boolean",
"is-self-join": "boolean",
"is-low-memory": "boolean",
"interface-name-xr": "string",
"router-filter-mode": "integer",
"explicit-tracking-enabled": "boolean"
},
"is-host-exclude-mode": "boolean"
}
]
}
DETAIL-GROUP - Retrieve
Retrieve operation of resource: detail-group
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"source": [
{
"uptime": "integer",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"expiration-time": "string",
"is-local": "boolean",
"is-forward": "boolean",
"is-added": "boolean",
"flags": "string",
"is-remote": "boolean",
"is-we-report": "boolean"
}
],
"is-router-exclude-mode": "boolean",
"group-info": {
"uptime": "integer",
"older-host-version1-timer": "integer",
"row-status": "string",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-added": "boolean",
"older-host-version2-timer": "integer",
"last-reporter": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"expiration-time": "string",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-suppressed": "boolean",
"is-self-join": "boolean",
"is-low-memory": "boolean",
"interface-name-xr": "string",
"router-filter-mode": "integer",
"explicit-tracking-enabled": "boolean"
},
"is-host-exclude-mode": "boolean"
}
GROUP-INFO - Retrieve
Retrieve operation of resource: group-info
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"uptime": "integer",
"older-host-version1-timer": "integer",
"row-status": "string",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-added": "boolean",
"older-host-version2-timer": "integer",
"last-reporter": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"expiration-time": "string",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-suppressed": "boolean",
"is-self-join": "boolean",
"is-low-memory": "boolean",
"interface-name-xr": "string",
"router-filter-mode": "integer",
"explicit-tracking-enabled": "boolean"
}
GROUP-ADDRESS-XR - Retrieve
Retrieve operation of resource: group-address-xr
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
LAST-REPORTER - Retrieve
Retrieve operation of resource: last-reporter
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SOURCE-ADDRESS - Retrieve
Retrieve operation of resource: source-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SOURCE - Retrieve
Retrieve operation of resource: source
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"uptime": "integer",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"expiration-time": "string",
"is-local": "boolean",
"is-forward": "boolean",
"is-added": "boolean",
"flags": "string",
"is-remote": "boolean",
"is-we-report": "boolean"
}
SOURCE-ADDRESS - Retrieve
Retrieve operation of resource: source-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
NON-ACTIVE-GROUPS - Retrieve
Retrieve operation of resource: non-active-groups
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"non-active-groups": [
{
"interface": "string",
"group-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"reason-for-non-activity": "string",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
}
NON-ACTIVE-GROUPS - Retrieve
Retrieve operation of resource: non-active-groups
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface": "string",
"group-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"reason-for-non-activity": "string",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
GROUP-ADDRESS - Retrieve
Retrieve operation of resource: group-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SOURCE-ADDRESS - Retrieve
Retrieve operation of resource: source-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SSM-MAPS - Retrieve
Retrieve operation of resource: ssm-maps
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ssm-map": [
{
"source-counts": "integer",
"map-type": "integer",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
}
SSM-MAP - Retrieve
Retrieve operation of resource: ssm-map
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"source-counts": "integer",
"map-type": "integer",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
GROUP-ADDRESS-XR - Retrieve
Retrieve operation of resource: group-address-xr
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
EXPLICIT-GROUPS - Retrieve
Retrieve operation of resource: explicit-groups
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"explicit-group": [
{
"exclude-hosts": "integer",
"host": [
{
"uptime": "integer",
"source-address": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"is-exclude": "boolean",
"expiration-time": "integer",
"source-count": "integer",
"address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
],
"include-hosts": "integer",
"group-info": {
"uptime": "integer",
"older-host-version1-timer": "integer",
"row-status": "string",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-added": "boolean",
"older-host-version2-timer": "integer",
"last-reporter": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"expiration-time": "string",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-suppressed": "boolean",
"is-self-join": "boolean",
"is-low-memory": "boolean",
"interface-name-xr": "string",
"router-filter-mode": "integer",
"explicit-tracking-enabled": "boolean"
}
}
]
}
EXPLICIT-GROUP - Retrieve
Retrieve operation of resource: explicit-group
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"exclude-hosts": "integer",
"host": [
{
"uptime": "integer",
"source-address": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"is-exclude": "boolean",
"expiration-time": "integer",
"source-count": "integer",
"address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
],
"include-hosts": "integer",
"group-info": {
"uptime": "integer",
"older-host-version1-timer": "integer",
"row-status": "string",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-added": "boolean",
"older-host-version2-timer": "integer",
"last-reporter": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"expiration-time": "string",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-suppressed": "boolean",
"is-self-join": "boolean",
"is-low-memory": "boolean",
"interface-name-xr": "string",
"router-filter-mode": "integer",
"explicit-tracking-enabled": "boolean"
}
}
GROUP-INFO - Retrieve
Retrieve operation of resource: group-info
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"uptime": "integer",
"older-host-version1-timer": "integer",
"row-status": "string",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-added": "boolean",
"older-host-version2-timer": "integer",
"last-reporter": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"expiration-time": "string",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-suppressed": "boolean",
"is-self-join": "boolean",
"is-low-memory": "boolean",
"interface-name-xr": "string",
"router-filter-mode": "integer",
"explicit-tracking-enabled": "boolean"
}
GROUP-ADDRESS-XR - Retrieve
Retrieve operation of resource: group-address-xr
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
LAST-REPORTER - Retrieve
Retrieve operation of resource: last-reporter
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SOURCE-ADDRESS - Retrieve
Retrieve operation of resource: source-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
HOST - Retrieve
Retrieve operation of resource: host
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"uptime": "integer",
"source-address": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"is-exclude": "boolean",
"expiration-time": "integer",
"source-count": "integer",
"address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
ADDRESS - Retrieve
Retrieve operation of resource: address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SOURCE-ADDRESS - Retrieve
Retrieve operation of resource: source-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
INTERFACE-TABLE - Retrieve
Retrieve operation of resource: interface-table
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface": [
{
"interface-name": "string",
"las-ll-remove-update-count": "integer",
"las-ll-add-update-count": "integer",
"las-update-count": "integer",
"configurationvrf-set": "boolean",
"vrf-id": "integer",
"subscriber-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"vrf-state": "integer",
"last-member-query-interval": "integer",
"interface-name-xr": "string",
"is-las-registered": "boolean",
"group-leaves": "integer",
"is-router-enabled": "boolean",
"las-get-address-count": "integer",
"subscriber-mode": "integer",
"total-active-groups": "integer",
"configuration-mcast-vrf-set": "boolean",
"querier-uptime": "integer",
"proxy-interface": "string",
"is-subscriber": "boolean",
"mte-vrf-id": "integer",
"state": "string",
"time-since-last-query-in-seconds": "integer",
"location": "integer",
"subscriber-id": "string",
"is-ip-enabled": "boolean",
"router-uptime-in-seconds": "integer",
"parent-ifhandle": "string",
"query-interval": "integer",
"configuration-mcast-vrf-error": "boolean",
"is-identity-present": "boolean",
"query-timeout": "integer",
"query-maximum-response-time": "integer",
"querier-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"igmp-version": "integer",
"las-ll-registration-count": "integer",
"is-interface-up": "boolean",
"mte-tuple-count": "integer",
"is-las-request": "boolean",
"prefix-length": "integer",
"las-null-update-count": "integer",
"is-querier": "boolean",
"robustness": "integer",
"las-unregistration-count": "integer",
"is-im-state-registered": "boolean",
"mtu": "integer",
"is-configurationverify": "boolean",
"time-since-last-report-in-seconds": "integer",
"configurationvrf-error": "boolean",
"host-version": "integer",
"group-joins": "integer"
}
]
}
INTERFACE - Retrieve
Retrieve operation of resource: interface
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"las-ll-remove-update-count": "integer",
"las-ll-add-update-count": "integer",
"las-update-count": "integer",
"configurationvrf-set": "boolean",
"vrf-id": "integer",
"subscriber-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"vrf-state": "integer",
"last-member-query-interval": "integer",
"interface-name-xr": "string",
"is-las-registered": "boolean",
"group-leaves": "integer",
"is-router-enabled": "boolean",
"las-get-address-count": "integer",
"subscriber-mode": "integer",
"total-active-groups": "integer",
"configuration-mcast-vrf-set": "boolean",
"querier-uptime": "integer",
"proxy-interface": "string",
"is-subscriber": "boolean",
"mte-vrf-id": "integer",
"state": "string",
"time-since-last-query-in-seconds": "integer",
"location": "integer",
"subscriber-id": "string",
"is-ip-enabled": "boolean",
"router-uptime-in-seconds": "integer",
"parent-ifhandle": "string",
"query-interval": "integer",
"configuration-mcast-vrf-error": "boolean",
"is-identity-present": "boolean",
"query-timeout": "integer",
"query-maximum-response-time": "integer",
"querier-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"igmp-version": "integer",
"las-ll-registration-count": "integer",
"is-interface-up": "boolean",
"mte-tuple-count": "integer",
"is-las-request": "boolean",
"prefix-length": "integer",
"las-null-update-count": "integer",
"is-querier": "boolean",
"robustness": "integer",
"las-unregistration-count": "integer",
"is-im-state-registered": "boolean",
"mtu": "integer",
"is-configurationverify": "boolean",
"time-since-last-report-in-seconds": "integer",
"configurationvrf-error": "boolean",
"host-version": "integer",
"group-joins": "integer"
}
ADDRESS - Retrieve
Retrieve operation of resource: address
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
QUERIER-ADDRESS - Retrieve
Retrieve operation of resource: querier-address
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SUBSCRIBER-ADDRESS - Retrieve
Retrieve operation of resource: subscriber-address
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
INTERFACE-UNICAST-QOS-ADJUSTS - Retrieve
Retrieve operation of resource: interface-unicast-qos-adjusts
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-unicast-qos-adjust": [
{
"is-virtual-access": "boolean",
"rate": "integer",
"rate-increments": "integer",
"rate-decrements": "integer",
"update": [
{
"is-add": "boolean",
"group-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"received-time": "integer",
"weight": "integer",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
}
]
}
INTERFACE-UNICAST-QOS-ADJUST - Retrieve
Retrieve operation of resource: interface-unicast-qos-adjust
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-virtual-access": "boolean",
"rate": "integer",
"rate-increments": "integer",
"rate-decrements": "integer",
"update": [
{
"is-add": "boolean",
"group-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"received-time": "integer",
"weight": "integer",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
}
UPDATE - Retrieve
Retrieve operation of resource: update
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-add": "boolean",
"group-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"received-time": "integer",
"weight": "integer",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
SOURCE-ADDRESS - Retrieve
Retrieve operation of resource: source-address
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
GROUP-ADDRESS - Retrieve
Retrieve operation of resource: group-address
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
RANGES - Retrieve
Retrieve operation of resource: ranges
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"range": [
{
"is-stale": "boolean",
"protocol": "string",
"prefix-length": "integer",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
}
RANGE - Retrieve
Retrieve operation of resource: range
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"is-stale": "boolean",
"protocol": "string",
"prefix-length": "integer",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
GROUP-ADDRESS-XR - Retrieve
Retrieve operation of resource: group-address-xr
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
IFRS-INTERFACES - Retrieve
Retrieve operation of resource: ifrs-interfaces
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ifrs-interface": [
{
"join-group-count": "integer",
"igmp-interface-entry": {
"las-ll-remove-update-count": "integer",
"las-ll-add-update-count": "integer",
"las-update-count": "integer",
"configurationvrf-set": "boolean",
"vrf-id": "integer",
"subscriber-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"vrf-state": "integer",
"last-member-query-interval": "integer",
"interface-name-xr": "string",
"is-las-registered": "boolean",
"group-leaves": "integer",
"is-router-enabled": "boolean",
"las-get-address-count": "integer",
"subscriber-mode": "integer",
"total-active-groups": "integer",
"configuration-mcast-vrf-set": "boolean",
"querier-uptime": "integer",
"proxy-interface": "string",
"is-subscriber": "boolean",
"mte-vrf-id": "integer",
"state": "string",
"time-since-last-query-in-seconds": "integer",
"location": "integer",
"subscriber-id": "string",
"is-ip-enabled": "boolean",
"router-uptime-in-seconds": "integer",
"parent-ifhandle": "string",
"query-interval": "integer",
"configuration-mcast-vrf-error": "boolean",
"is-identity-present": "boolean",
"query-timeout": "integer",
"query-maximum-response-time": "integer",
"querier-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"igmp-version": "integer",
"las-ll-registration-count": "integer",
"is-interface-up": "boolean",
"mte-tuple-count": "integer",
"is-las-request": "boolean",
"prefix-length": "integer",
"las-null-update-count": "integer",
"is-querier": "boolean",
"robustness": "integer",
"las-unregistration-count": "integer",
"is-im-state-registered": "boolean",
"mtu": "integer",
"is-configurationverify": "boolean",
"time-since-last-report-in-seconds": "integer",
"configurationvrf-error": "boolean",
"host-version": "integer",
"group-joins": "integer"
}
}
]
}
IFRS-INTERFACE - Retrieve
Retrieve operation of resource: ifrs-interface
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"join-group-count": "integer",
"igmp-interface-entry": {
"las-ll-remove-update-count": "integer",
"las-ll-add-update-count": "integer",
"las-update-count": "integer",
"configurationvrf-set": "boolean",
"vrf-id": "integer",
"subscriber-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"vrf-state": "integer",
"last-member-query-interval": "integer",
"interface-name-xr": "string",
"is-las-registered": "boolean",
"group-leaves": "integer",
"is-router-enabled": "boolean",
"las-get-address-count": "integer",
"subscriber-mode": "integer",
"total-active-groups": "integer",
"configuration-mcast-vrf-set": "boolean",
"querier-uptime": "integer",
"proxy-interface": "string",
"is-subscriber": "boolean",
"mte-vrf-id": "integer",
"state": "string",
"time-since-last-query-in-seconds": "integer",
"location": "integer",
"subscriber-id": "string",
"is-ip-enabled": "boolean",
"router-uptime-in-seconds": "integer",
"parent-ifhandle": "string",
"query-interval": "integer",
"configuration-mcast-vrf-error": "boolean",
"is-identity-present": "boolean",
"query-timeout": "integer",
"query-maximum-response-time": "integer",
"querier-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"igmp-version": "integer",
"las-ll-registration-count": "integer",
"is-interface-up": "boolean",
"mte-tuple-count": "integer",
"is-las-request": "boolean",
"prefix-length": "integer",
"las-null-update-count": "integer",
"is-querier": "boolean",
"robustness": "integer",
"las-unregistration-count": "integer",
"is-im-state-registered": "boolean",
"mtu": "integer",
"is-configurationverify": "boolean",
"time-since-last-report-in-seconds": "integer",
"configurationvrf-error": "boolean",
"host-version": "integer",
"group-joins": "integer"
}
}
IGMP-INTERFACE-ENTRY - Retrieve
Retrieve operation of resource: igmp-interface-entry
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"las-ll-remove-update-count": "integer",
"las-ll-add-update-count": "integer",
"las-update-count": "integer",
"configurationvrf-set": "boolean",
"vrf-id": "integer",
"subscriber-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"vrf-state": "integer",
"last-member-query-interval": "integer",
"interface-name-xr": "string",
"is-las-registered": "boolean",
"group-leaves": "integer",
"is-router-enabled": "boolean",
"las-get-address-count": "integer",
"subscriber-mode": "integer",
"total-active-groups": "integer",
"configuration-mcast-vrf-set": "boolean",
"querier-uptime": "integer",
"proxy-interface": "string",
"is-subscriber": "boolean",
"mte-vrf-id": "integer",
"state": "string",
"time-since-last-query-in-seconds": "integer",
"location": "integer",
"subscriber-id": "string",
"is-ip-enabled": "boolean",
"router-uptime-in-seconds": "integer",
"parent-ifhandle": "string",
"query-interval": "integer",
"configuration-mcast-vrf-error": "boolean",
"is-identity-present": "boolean",
"query-timeout": "integer",
"query-maximum-response-time": "integer",
"querier-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"igmp-version": "integer",
"las-ll-registration-count": "integer",
"is-interface-up": "boolean",
"mte-tuple-count": "integer",
"is-las-request": "boolean",
"prefix-length": "integer",
"las-null-update-count": "integer",
"is-querier": "boolean",
"robustness": "integer",
"las-unregistration-count": "integer",
"is-im-state-registered": "boolean",
"mtu": "integer",
"is-configurationverify": "boolean",
"time-since-last-report-in-seconds": "integer",
"configurationvrf-error": "boolean",
"host-version": "integer",
"group-joins": "integer"
}
ADDRESS - Retrieve
Retrieve operation of resource: address
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
QUERIER-ADDRESS - Retrieve
Retrieve operation of resource: querier-address
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SUBSCRIBER-ADDRESS - Retrieve
Retrieve operation of resource: subscriber-address
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
TRAFFIC-COUNTERS - Retrieve
Retrieve operation of resource: traffic-counters
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"checksum-errors": "integer",
"auxillary-data-length-errors": "integer",
"input-mtrace": "integer",
"socket-errors": "integer",
"packet-manager-input-errors": "integer",
"packets-out": "integer",
"input-no-idb": "integer",
"output-no-parent-interface-handle": "integer",
"receive-socket-errors": "integer",
"output-leaves": "integer",
"no-socket-connection": "integer",
"bad-scope-errors": "integer",
"input-leaves": "integer",
"invalid-source-address-errors": "integer",
"get-packet-failure": "integer",
"input-dvmrp": "integer",
"miscellaneous-errors": "integer",
"elapsed-time": "integer",
"input-no-platform-support-mtrace": "integer",
"input-queries": "integer",
"output-pim": "integer",
"input-disabled-idb": "integer",
"packet-manager-output-errors": "integer",
"format-errors": "integer",
"packets-in": "integer",
"input-no-vrf-mtrace": "integer",
"input-no-assigned-vrf-id": "integer",
"input-reports": "integer",
"input-pim": "integer",
"input-martian-address": "integer",
"output-queries": "integer",
"input-no-vrf-in-idb": "integer",
"output-mtrace": "integer",
"output-reports": "integer",
"output-dvmrp": "integer"
}
GROUPS - Retrieve
Retrieve operation of resource: groups
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"group": [
{
"uptime": "integer",
"older-host-version1-timer": "integer",
"row-status": "string",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-added": "boolean",
"older-host-version2-timer": "integer",
"last-reporter": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"expiration-time": "string",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-suppressed": "boolean",
"is-self-join": "boolean",
"is-low-memory": "boolean",
"interface-name-xr": "string",
"router-filter-mode": "integer",
"explicit-tracking-enabled": "boolean"
}
]
}
GROUP - Retrieve
Retrieve operation of resource: group
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"uptime": "integer",
"older-host-version1-timer": "integer",
"row-status": "string",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-added": "boolean",
"older-host-version2-timer": "integer",
"last-reporter": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"expiration-time": "string",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-suppressed": "boolean",
"is-self-join": "boolean",
"is-low-memory": "boolean",
"interface-name-xr": "string",
"router-filter-mode": "integer",
"explicit-tracking-enabled": "boolean"
}
GROUP-ADDRESS-XR - Retrieve
Retrieve operation of resource: group-address-xr
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
LAST-REPORTER - Retrieve
Retrieve operation of resource: last-reporter
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SOURCE-ADDRESS - Retrieve
Retrieve operation of resource: source-address
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
GROUP-SUMMARY - Retrieve
Retrieve operation of resource: group-summary
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"group-count": "integer",
"groutes": "integer",
"sg-routes": "integer",
"is-low-memory": "boolean"
}
IFRS-INTERFACE-SUMMARY - Retrieve
Retrieve operation of resource: ifrs-interface-summary
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-count": "integer",
"configuration-count": "integer"
}
GLOBAL-INTERFACE-TABLE - Retrieve
Retrieve operation of resource: global-interface-table
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface": [
{
"interface-name": "string",
"las-ll-remove-update-count": "integer",
"las-ll-add-update-count": "integer",
"las-update-count": "integer",
"configurationvrf-set": "boolean",
"vrf-id": "integer",
"subscriber-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"vrf-state": "integer",
"last-member-query-interval": "integer",
"interface-name-xr": "string",
"is-las-registered": "boolean",
"group-leaves": "integer",
"is-router-enabled": "boolean",
"las-get-address-count": "integer",
"subscriber-mode": "integer",
"total-active-groups": "integer",
"configuration-mcast-vrf-set": "boolean",
"querier-uptime": "integer",
"proxy-interface": "string",
"is-subscriber": "boolean",
"mte-vrf-id": "integer",
"state": "string",
"time-since-last-query-in-seconds": "integer",
"location": "integer",
"subscriber-id": "string",
"is-ip-enabled": "boolean",
"router-uptime-in-seconds": "integer",
"parent-ifhandle": "string",
"query-interval": "integer",
"configuration-mcast-vrf-error": "boolean",
"is-identity-present": "boolean",
"query-timeout": "integer",
"query-maximum-response-time": "integer",
"querier-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"igmp-version": "integer",
"las-ll-registration-count": "integer",
"is-interface-up": "boolean",
"mte-tuple-count": "integer",
"is-las-request": "boolean",
"prefix-length": "integer",
"las-null-update-count": "integer",
"is-querier": "boolean",
"robustness": "integer",
"las-unregistration-count": "integer",
"is-im-state-registered": "boolean",
"mtu": "integer",
"is-configurationverify": "boolean",
"time-since-last-report-in-seconds": "integer",
"configurationvrf-error": "boolean",
"host-version": "integer",
"group-joins": "integer"
}
]
}
INTERFACE - Retrieve
Retrieve operation of resource: interface
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"las-ll-remove-update-count": "integer",
"las-ll-add-update-count": "integer",
"las-update-count": "integer",
"configurationvrf-set": "boolean",
"vrf-id": "integer",
"subscriber-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"vrf-state": "integer",
"last-member-query-interval": "integer",
"interface-name-xr": "string",
"is-las-registered": "boolean",
"group-leaves": "integer",
"is-router-enabled": "boolean",
"las-get-address-count": "integer",
"subscriber-mode": "integer",
"total-active-groups": "integer",
"configuration-mcast-vrf-set": "boolean",
"querier-uptime": "integer",
"proxy-interface": "string",
"is-subscriber": "boolean",
"mte-vrf-id": "integer",
"state": "string",
"time-since-last-query-in-seconds": "integer",
"location": "integer",
"subscriber-id": "string",
"is-ip-enabled": "boolean",
"router-uptime-in-seconds": "integer",
"parent-ifhandle": "string",
"query-interval": "integer",
"configuration-mcast-vrf-error": "boolean",
"is-identity-present": "boolean",
"query-timeout": "integer",
"query-maximum-response-time": "integer",
"querier-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"igmp-version": "integer",
"las-ll-registration-count": "integer",
"is-interface-up": "boolean",
"mte-tuple-count": "integer",
"is-las-request": "boolean",
"prefix-length": "integer",
"las-null-update-count": "integer",
"is-querier": "boolean",
"robustness": "integer",
"las-unregistration-count": "integer",
"is-im-state-registered": "boolean",
"mtu": "integer",
"is-configurationverify": "boolean",
"time-since-last-report-in-seconds": "integer",
"configurationvrf-error": "boolean",
"host-version": "integer",
"group-joins": "integer"
}
ADDRESS - Retrieve
Retrieve operation of resource: address
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
QUERIER-ADDRESS - Retrieve
Retrieve operation of resource: querier-address
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SUBSCRIBER-ADDRESS - Retrieve
Retrieve operation of resource: subscriber-address
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SSM-MAP-DETAILS - Retrieve
Retrieve operation of resource: ssm-map-details
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"ssm-map-detail": [
{
"response-pending": "boolean",
"query-interval": "integer",
"map-info": {
"source-counts": "integer",
"map-type": "integer",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
},
"expiration-time": "integer",
"sources": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"elapsed-time": "integer"
}
]
}
SSM-MAP-DETAIL - Retrieve
Retrieve operation of resource: ssm-map-detail
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"response-pending": "boolean",
"query-interval": "integer",
"map-info": {
"source-counts": "integer",
"map-type": "integer",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
},
"expiration-time": "integer",
"sources": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"elapsed-time": "integer"
}
MAP-INFO - Retrieve
Retrieve operation of resource: map-info
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"source-counts": "integer",
"map-type": "integer",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
GROUP-ADDRESS-XR - Retrieve
Retrieve operation of resource: group-address-xr
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SOURCES - Retrieve
Retrieve operation of resource: sources
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
INTERFACE-STATE-OFFS - Retrieve
Retrieve operation of resource: interface-state-offs
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"interface-state-off": [
{
"las-ll-remove-update-count": "integer",
"las-ll-add-update-count": "integer",
"las-update-count": "integer",
"configurationvrf-set": "boolean",
"vrf-id": "integer",
"subscriber-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"vrf-state": "integer",
"last-member-query-interval": "integer",
"interface-name-xr": "string",
"is-las-registered": "boolean",
"group-leaves": "integer",
"is-router-enabled": "boolean",
"las-get-address-count": "integer",
"subscriber-mode": "integer",
"total-active-groups": "integer",
"configuration-mcast-vrf-set": "boolean",
"querier-uptime": "integer",
"proxy-interface": "string",
"is-subscriber": "boolean",
"mte-vrf-id": "integer",
"state": "string",
"time-since-last-query-in-seconds": "integer",
"location": "integer",
"subscriber-id": "string",
"is-ip-enabled": "boolean",
"router-uptime-in-seconds": "integer",
"parent-ifhandle": "string",
"query-interval": "integer",
"configuration-mcast-vrf-error": "boolean",
"is-identity-present": "boolean",
"query-timeout": "integer",
"query-maximum-response-time": "integer",
"querier-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"igmp-version": "integer",
"las-ll-registration-count": "integer",
"is-interface-up": "boolean",
"mte-tuple-count": "integer",
"is-las-request": "boolean",
"prefix-length": "integer",
"las-null-update-count": "integer",
"is-querier": "boolean",
"robustness": "integer",
"las-unregistration-count": "integer",
"is-im-state-registered": "boolean",
"mtu": "integer",
"is-configurationverify": "boolean",
"time-since-last-report-in-seconds": "integer",
"configurationvrf-error": "boolean",
"host-version": "integer",
"group-joins": "integer"
}
]
}
INTERFACE-STATE-OFF - Retrieve
Retrieve operation of resource: interface-state-off
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"las-ll-remove-update-count": "integer",
"las-ll-add-update-count": "integer",
"las-update-count": "integer",
"configurationvrf-set": "boolean",
"vrf-id": "integer",
"subscriber-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"vrf-state": "integer",
"last-member-query-interval": "integer",
"interface-name-xr": "string",
"is-las-registered": "boolean",
"group-leaves": "integer",
"is-router-enabled": "boolean",
"las-get-address-count": "integer",
"subscriber-mode": "integer",
"total-active-groups": "integer",
"configuration-mcast-vrf-set": "boolean",
"querier-uptime": "integer",
"proxy-interface": "string",
"is-subscriber": "boolean",
"mte-vrf-id": "integer",
"state": "string",
"time-since-last-query-in-seconds": "integer",
"location": "integer",
"subscriber-id": "string",
"is-ip-enabled": "boolean",
"router-uptime-in-seconds": "integer",
"parent-ifhandle": "string",
"query-interval": "integer",
"configuration-mcast-vrf-error": "boolean",
"is-identity-present": "boolean",
"query-timeout": "integer",
"query-maximum-response-time": "integer",
"querier-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"igmp-version": "integer",
"las-ll-registration-count": "integer",
"is-interface-up": "boolean",
"mte-tuple-count": "integer",
"is-las-request": "boolean",
"prefix-length": "integer",
"las-null-update-count": "integer",
"is-querier": "boolean",
"robustness": "integer",
"las-unregistration-count": "integer",
"is-im-state-registered": "boolean",
"mtu": "integer",
"is-configurationverify": "boolean",
"time-since-last-report-in-seconds": "integer",
"configurationvrf-error": "boolean",
"host-version": "integer",
"group-joins": "integer"
}
ADDRESS - Retrieve
Retrieve operation of resource: address
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
QUERIER-ADDRESS - Retrieve
Retrieve operation of resource: querier-address
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
SUBSCRIBER-ADDRESS - Retrieve
Retrieve operation of resource: subscriber-address
interface-name
in path
string
ID of interface-name
200 OK
Successful operation
400 Bad Request
Internal Error
Response Content-Types: application/json
Response Example (200 OK)
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
Schema Definitions
IGMP-EDM-GROUPS-DETAIL-BAG:
IGMP group detail entry
- source: IGMP-EDM-GROUPS-SOURCE-BAG
-
List of sources
- is-router-exclude-mode: boolean
-
Group router filter mode
- group-info: IGMP-EDM-GROUPS-BAG
-
Basic Group information
- is-host-exclude-mode: boolean
-
Group host filter mode
Example
{
"source": [
{
"uptime": "integer",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"expiration-time": "string",
"is-local": "boolean",
"is-forward": "boolean",
"is-added": "boolean",
"flags": "string",
"is-remote": "boolean",
"is-we-report": "boolean"
}
],
"is-router-exclude-mode": "boolean",
"group-info": {
"uptime": "integer",
"older-host-version1-timer": "integer",
"row-status": "string",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-added": "boolean",
"older-host-version2-timer": "integer",
"last-reporter": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"expiration-time": "string",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-suppressed": "boolean",
"is-self-join": "boolean",
"is-low-memory": "boolean",
"interface-name-xr": "string",
"router-filter-mode": "integer",
"explicit-tracking-enabled": "boolean"
},
"is-host-exclude-mode": "boolean"
}
IGMP-EDM-SSM-MAP-BAG:
IGMP SSM Map List
- source-counts: integer
-
Count of Sources
- map-type: integer
-
Map Type of group
- group-address-xr: IGMP-ADDRTYPE
-
Group Address
Example
{
"source-counts": "integer",
"map-type": "integer",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
STANDBY:
Common node of igmp, mld
- standby: DEFAULT-CONTEXT
-
Standby Process
Example
{
"standby": {
"default-context": {
"interface-state-offs": {
"interface-state-off": [
{
"interface-name": "string",
"las-ll-remove-update-count": "integer",
"las-ll-add-update-count": "integer",
"las-update-count": "integer",
"configurationvrf-set": "boolean",
"vrf-id": "integer",
"subscriber-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"vrf-state": "integer",
"last-member-query-interval": "integer",
"interface-name-xr": "string",
"is-las-registered": "boolean",
"group-leaves": "integer",
"is-router-enabled": "boolean",
"las-get-address-count": "integer",
"subscriber-mode": "integer",
"total-active-groups": "integer",
"configuration-mcast-vrf-set": "boolean",
"querier-uptime": "integer",
"proxy-interface": "string",
"is-subscriber": "boolean",
"mte-vrf-id": "integer",
"state": "string",
"time-since-last-query-in-seconds": "integer",
"location": "integer",
"subscriber-id": "string",
"is-ip-enabled": "boolean",
"router-uptime-in-seconds": "integer",
"parent-ifhandle": "string",
"query-interval": "integer",
"configuration-mcast-vrf-error": "boolean",
"is-identity-present": "boolean",
"query-timeout": "integer",
"query-maximum-response-time": "integer",
"querier-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"igmp-version": "integer",
"las-ll-registration-count": "integer",
"is-interface-up": "boolean",
"mte-tuple-count": "integer",
"is-las-request": "boolean",
"prefix-length": "integer",
"las-null-update-count": "integer",
"is-querier": "boolean",
"robustness": "integer",
"las-unregistration-count": "integer",
"is-im-state-registered": "boolean",
"mtu": "integer",
"is-configurationverify": "boolean",
"time-since-last-report-in-seconds": "integer",
"configurationvrf-error": "boolean",
"host-version": "integer",
"group-joins": "integer"
}
]
}
}
}
}
IGMP-EDM-NOT-ACTIVE-GROUP-BAG:
IGMP Non active group
- interface: string
-
Interface Name
- group-address: IGMP-ADDRTYPE
-
Group Address
- reason-for-non-activity: string
-
Reason for group join not being processed
- source-address: IGMP-ADDRTYPE
-
Source Address
Example
{
"interface": "string",
"group-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"reason-for-non-activity": "string",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
IGMP-EDM-GROUPS-SOURCE-BAG:
IGMP Groups source entry
- uptime: integer
-
Uptime in seconds
- source-address: IGMP-ADDRTYPE
-
Source Address
- expiration-time: string
-
Expiration time in seconds
- is-local: boolean
-
Is this a local source
- is-forward: boolean
-
Should we forward on this entry
- is-added: boolean
-
Joined
- flags: string
-
Source flags
- is-remote: boolean
-
Is this a remote source
- is-we-report: boolean
-
Should we report the source
Example
{
"uptime": "integer",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"expiration-time": "string",
"is-local": "boolean",
"is-forward": "boolean",
"is-added": "boolean",
"flags": "string",
"is-remote": "boolean",
"is-we-report": "boolean"
}
RANGE-TABLE:
Common node of vrf, default-context
- ranges: object
-
Range table
Example
{
"ranges": {
"range": [
{
"group-address": "string",
"group-mask": "integer",
"is-stale": "boolean",
"protocol": "string",
"prefix-length": "integer",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
}
}
SSM-MAP-TABLE:
Common node of vrf, default-context
- ssm-maps: object
-
SSM Map Table
Example
{
"ssm-maps": {
"ssm-map": [
{
"group-address": "string",
"ssm-map-type": "string",
"source-counts": "integer",
"map-type": "integer",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
}
}
IFRS-INTERFACE-TABLE:
Common node of vrf, default-context
- ifrs-interfaces: object
-
IGMP Interface specific
Example
{
"ifrs-interfaces": {
"ifrs-interface": [
{
"interface-name": "string",
"join-group-count": "integer",
"igmp-interface-entry": {
"las-ll-remove-update-count": "integer",
"las-ll-add-update-count": "integer",
"las-update-count": "integer",
"configurationvrf-set": "boolean",
"vrf-id": "integer",
"subscriber-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"vrf-state": "integer",
"last-member-query-interval": "integer",
"interface-name-xr": "string",
"is-las-registered": "boolean",
"group-leaves": "integer",
"is-router-enabled": "boolean",
"las-get-address-count": "integer",
"subscriber-mode": "integer",
"total-active-groups": "integer",
"configuration-mcast-vrf-set": "boolean",
"querier-uptime": "integer",
"proxy-interface": "string",
"is-subscriber": "boolean",
"mte-vrf-id": "integer",
"state": "string",
"time-since-last-query-in-seconds": "integer",
"location": "integer",
"subscriber-id": "string",
"is-ip-enabled": "boolean",
"router-uptime-in-seconds": "integer",
"parent-ifhandle": "string",
"query-interval": "integer",
"configuration-mcast-vrf-error": "boolean",
"is-identity-present": "boolean",
"query-timeout": "integer",
"query-maximum-response-time": "integer",
"querier-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"igmp-version": "integer",
"las-ll-registration-count": "integer",
"is-interface-up": "boolean",
"mte-tuple-count": "integer",
"is-las-request": "boolean",
"prefix-length": "integer",
"las-null-update-count": "integer",
"is-querier": "boolean",
"robustness": "integer",
"las-unregistration-count": "integer",
"is-im-state-registered": "boolean",
"mtu": "integer",
"is-configurationverify": "boolean",
"time-since-last-report-in-seconds": "integer",
"configurationvrf-error": "boolean",
"host-version": "integer",
"group-joins": "integer"
}
}
]
}
}
INTERFACE-STATE-OFF-TABLE:
Common node of vrf, default-context
- interface-state-offs: object
-
IGMP Interface state off
Example
{
"interface-state-offs": {
"interface-state-off": [
{
"interface-name": "string",
"las-ll-remove-update-count": "integer",
"las-ll-add-update-count": "integer",
"las-update-count": "integer",
"configurationvrf-set": "boolean",
"vrf-id": "integer",
"subscriber-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"vrf-state": "integer",
"last-member-query-interval": "integer",
"interface-name-xr": "string",
"is-las-registered": "boolean",
"group-leaves": "integer",
"is-router-enabled": "boolean",
"las-get-address-count": "integer",
"subscriber-mode": "integer",
"total-active-groups": "integer",
"configuration-mcast-vrf-set": "boolean",
"querier-uptime": "integer",
"proxy-interface": "string",
"is-subscriber": "boolean",
"mte-vrf-id": "integer",
"state": "string",
"time-since-last-query-in-seconds": "integer",
"location": "integer",
"subscriber-id": "string",
"is-ip-enabled": "boolean",
"router-uptime-in-seconds": "integer",
"parent-ifhandle": "string",
"query-interval": "integer",
"configuration-mcast-vrf-error": "boolean",
"is-identity-present": "boolean",
"query-timeout": "integer",
"query-maximum-response-time": "integer",
"querier-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"igmp-version": "integer",
"las-ll-registration-count": "integer",
"is-interface-up": "boolean",
"mte-tuple-count": "integer",
"is-las-request": "boolean",
"prefix-length": "integer",
"las-null-update-count": "integer",
"is-querier": "boolean",
"robustness": "integer",
"las-unregistration-count": "integer",
"is-im-state-registered": "boolean",
"mtu": "integer",
"is-configurationverify": "boolean",
"time-since-last-report-in-seconds": "integer",
"configurationvrf-error": "boolean",
"host-version": "integer",
"group-joins": "integer"
}
]
}
}
IGMP-EDM-TRAFFIC-BAG:
IGMP Traffic Counters bag
- checksum-errors: integer
-
Checksum errors
- auxillary-data-length-errors: integer
-
AuxDataLen errors
- input-mtrace: integer
-
Mtrace packets in
- socket-errors: integer
-
Socket errors on send
- packet-manager-input-errors: integer
-
Incoming Packet Manager packets dropped
- packets-out: integer
-
Packets out
- input-no-idb: integer
-
Packets received without idb
- output-no-parent-interface-handle: integer
-
Failures setting 2nd ifhandle
- receive-socket-errors: integer
-
Socket errors on reception
- output-leaves: integer
-
Leaves out
- no-socket-connection: integer
-
Packets dropped since no socket connection
- bad-scope-errors: integer
-
BadScope errors
- input-leaves: integer
-
Leaves in
- invalid-source-address-errors: integer
-
Invalid Source Address errors
- get-packet-failure: integer
-
Packet get failed
- input-dvmrp: integer
-
DVMRP packets in
- miscellaneous-errors: integer
-
Packets dropped for other reasons
- elapsed-time: integer
-
Running time for counters
- input-no-platform-support-mtrace: integer
-
mtrace packets without platform support
- input-queries: integer
-
Query packets in
- output-pim: integer
-
PIM packets out
- input-disabled-idb: integer
-
Packet received on disabled idb
- packet-manager-output-errors: integer
-
Outgoing Packet Manager packets dropped
- format-errors: integer
-
Malformed packets in
- packets-in: integer
-
Packets in
- input-no-vrf-mtrace: integer
-
mtrace packets with no vrf associated
- input-no-assigned-vrf-id: integer
-
Packets received with no assigned vrf id
- input-reports: integer
-
Reports in
- input-pim: integer
-
PIM packets in
- input-martian-address: integer
-
Packets received with Martian Address
- output-queries: integer
-
Query packets out
- input-no-vrf-in-idb: integer
-
Packets received on idb without VRF
- output-mtrace: integer
-
Mtrace packets out
- output-reports: integer
-
Reports out
- output-dvmrp: integer
-
DVMRP packets out
Example
{
"checksum-errors": "integer",
"auxillary-data-length-errors": "integer",
"input-mtrace": "integer",
"socket-errors": "integer",
"packet-manager-input-errors": "integer",
"packets-out": "integer",
"input-no-idb": "integer",
"output-no-parent-interface-handle": "integer",
"receive-socket-errors": "integer",
"output-leaves": "integer",
"no-socket-connection": "integer",
"bad-scope-errors": "integer",
"input-leaves": "integer",
"invalid-source-address-errors": "integer",
"get-packet-failure": "integer",
"input-dvmrp": "integer",
"miscellaneous-errors": "integer",
"elapsed-time": "integer",
"input-no-platform-support-mtrace": "integer",
"input-queries": "integer",
"output-pim": "integer",
"input-disabled-idb": "integer",
"packet-manager-output-errors": "integer",
"format-errors": "integer",
"packets-in": "integer",
"input-no-vrf-mtrace": "integer",
"input-no-assigned-vrf-id": "integer",
"input-reports": "integer",
"input-pim": "integer",
"input-martian-address": "integer",
"output-queries": "integer",
"input-no-vrf-in-idb": "integer",
"output-mtrace": "integer",
"output-reports": "integer",
"output-dvmrp": "integer"
}
IGMP-EDM-GROUPS-ET-BAG:
IGMP group explicit-tracking entry
- exclude-hosts: integer
-
No. of hosts who are excluded
- host: IGMP-EDM-GROUPS-HOST-BAG
-
List of hosts
- include-hosts: integer
-
No. of hosts who are included
- group-info: IGMP-EDM-GROUPS-BAG
-
Basic Group information
Example
{
"exclude-hosts": "integer",
"host": [
{
"uptime": "integer",
"source-address": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"is-exclude": "boolean",
"expiration-time": "integer",
"source-count": "integer",
"address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
],
"include-hosts": "integer",
"group-info": {
"uptime": "integer",
"older-host-version1-timer": "integer",
"row-status": "string",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-added": "boolean",
"older-host-version2-timer": "integer",
"last-reporter": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"expiration-time": "string",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-suppressed": "boolean",
"is-self-join": "boolean",
"is-low-memory": "boolean",
"interface-name-xr": "string",
"router-filter-mode": "integer",
"explicit-tracking-enabled": "boolean"
}
}
IGMP-EDM-NSR-BAG:
IGMP NSR state
- collab-conv-done: boolean
-
Collaborators convergence done
- rmf-notification-done: boolean
-
RMF Notification done
- last-rmf-not-ready: integer
-
Time when RMF Not-Rdy notif was sent
- count-proc-connection-dn: integer
-
No. of times process connection went down
- count-rmf-ready: integer
-
No. of times RMF Ready notif was sent
- state: integer
-
NSR state
- count-proc-connection-up: integer
-
No. of times process connection went up
- last-proc: integer
-
Time when process came up
- count-rmf-not-ready: integer
-
No. of times RMF Not Ready notif was sent
- last-proc-connection-up: integer
-
Time when process connection went up
- last-proc-connection-dn: integer
-
Time when process connection went down
- last-rmf-ready: integer
-
Time when RMF Rdy notif was sent
- partner-proc-connected: boolean
-
Partner process connected
Example
{
"collab-conv-done": "boolean",
"rmf-notification-done": "boolean",
"last-rmf-not-ready": "integer",
"count-proc-connection-dn": "integer",
"count-rmf-ready": "integer",
"state": "integer",
"count-proc-connection-up": "integer",
"last-proc": "integer",
"count-rmf-not-ready": "integer",
"last-proc-connection-up": "integer",
"last-proc-connection-dn": "integer",
"last-rmf-ready": "integer",
"partner-proc-connected": "boolean"
}
IGMP-EDM-I2Q-STATS-BAG:
IGMP Rate Adjust Stats
- is-qos-s-sweeped: boolean
-
Is QOS Sweeped once
- batches: integer
-
I2Q Rate Batch count
- send-errors: integer
-
Number of Send errors in batch
- last-download-time: integer
-
Time elapsed since Last download to QOS in seconds
- sent-resync-bulks: integer
-
Number of bulks sent for last resync received
- is-resync-required: boolean
-
Is Resync required
- queues: integer
-
I2Q Queue count
- is-resync-start-sent: boolean
-
Is Resync Start message sent
- send-partial-errors: integer
-
Send Error due to partial issue count
- last-sweep-time: integer
-
Time elapsed since Last mark and sweep in seconds
- send-success: integer
-
Send Success count
- is-resync-received: boolean
-
Is Resync request received
- add-to-batches: integer
-
Add to batch count
- received-resync-requests: integer
-
Number of Resync request received
- send-comm-errors: integer
-
Send Error due to comms count
- delete-to-batches: integer
-
Delete to batch count
Example
{
"is-qos-s-sweeped": "boolean",
"batches": "integer",
"send-errors": "integer",
"last-download-time": "integer",
"sent-resync-bulks": "integer",
"is-resync-required": "boolean",
"queues": "integer",
"is-resync-start-sent": "boolean",
"send-partial-errors": "integer",
"last-sweep-time": "integer",
"send-success": "integer",
"is-resync-received": "boolean",
"add-to-batches": "integer",
"received-resync-requests": "integer",
"send-comm-errors": "integer",
"delete-to-batches": "integer"
}
TRAFFIC-COUNTERS:
Common node of vrf, default-context
- traffic-counters: IGMP-EDM-TRAFFIC-BAG
-
IGMP Message Traffic Counters
Example
{
"traffic-counters": {
"checksum-errors": "integer",
"auxillary-data-length-errors": "integer",
"input-mtrace": "integer",
"socket-errors": "integer",
"packet-manager-input-errors": "integer",
"packets-out": "integer",
"input-no-idb": "integer",
"output-no-parent-interface-handle": "integer",
"receive-socket-errors": "integer",
"output-leaves": "integer",
"no-socket-connection": "integer",
"bad-scope-errors": "integer",
"input-leaves": "integer",
"invalid-source-address-errors": "integer",
"get-packet-failure": "integer",
"input-dvmrp": "integer",
"miscellaneous-errors": "integer",
"elapsed-time": "integer",
"input-no-platform-support-mtrace": "integer",
"input-queries": "integer",
"output-pim": "integer",
"input-disabled-idb": "integer",
"packet-manager-output-errors": "integer",
"format-errors": "integer",
"packets-in": "integer",
"input-no-vrf-mtrace": "integer",
"input-no-assigned-vrf-id": "integer",
"input-reports": "integer",
"input-pim": "integer",
"input-martian-address": "integer",
"output-queries": "integer",
"input-no-vrf-in-idb": "integer",
"output-mtrace": "integer",
"output-reports": "integer",
"output-dvmrp": "integer"
}
}
VRF-TABLE:
Common node of active, standby
- vrfs: object
-
VRF Table
Example
{
"vrfs": {
"vrf": [
{
"vrf-name": "string",
"interface-state-offs": {
"interface-state-off": [
{
"interface-name": "string",
"las-ll-remove-update-count": "integer",
"las-ll-add-update-count": "integer",
"las-update-count": "integer",
"configurationvrf-set": "boolean",
"vrf-id": "integer",
"subscriber-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"vrf-state": "integer",
"last-member-query-interval": "integer",
"interface-name-xr": "string",
"is-las-registered": "boolean",
"group-leaves": "integer",
"is-router-enabled": "boolean",
"las-get-address-count": "integer",
"subscriber-mode": "integer",
"total-active-groups": "integer",
"configuration-mcast-vrf-set": "boolean",
"querier-uptime": "integer",
"proxy-interface": "string",
"is-subscriber": "boolean",
"mte-vrf-id": "integer",
"state": "string",
"time-since-last-query-in-seconds": "integer",
"location": "integer",
"subscriber-id": "string",
"is-ip-enabled": "boolean",
"router-uptime-in-seconds": "integer",
"parent-ifhandle": "string",
"query-interval": "integer",
"configuration-mcast-vrf-error": "boolean",
"is-identity-present": "boolean",
"query-timeout": "integer",
"query-maximum-response-time": "integer",
"querier-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"igmp-version": "integer",
"las-ll-registration-count": "integer",
"is-interface-up": "boolean",
"mte-tuple-count": "integer",
"is-las-request": "boolean",
"prefix-length": "integer",
"las-null-update-count": "integer",
"is-querier": "boolean",
"robustness": "integer",
"las-unregistration-count": "integer",
"is-im-state-registered": "boolean",
"mtu": "integer",
"is-configurationverify": "boolean",
"time-since-last-report-in-seconds": "integer",
"configurationvrf-error": "boolean",
"host-version": "integer",
"group-joins": "integer"
}
]
}
}
]
}
}
INTERFACE-TABLE:
Common node of vrf, default-context
- interface-table: INTERFACE
-
IGMP Interface specific Table
Example
{
"interface-table": {
"interface": [
{
"interface-name": "string",
"las-ll-remove-update-count": "integer",
"las-ll-add-update-count": "integer",
"las-update-count": "integer",
"configurationvrf-set": "boolean",
"vrf-id": "integer",
"subscriber-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"vrf-state": "integer",
"last-member-query-interval": "integer",
"interface-name-xr": "string",
"is-las-registered": "boolean",
"group-leaves": "integer",
"is-router-enabled": "boolean",
"las-get-address-count": "integer",
"subscriber-mode": "integer",
"total-active-groups": "integer",
"configuration-mcast-vrf-set": "boolean",
"querier-uptime": "integer",
"proxy-interface": "string",
"is-subscriber": "boolean",
"mte-vrf-id": "integer",
"state": "string",
"time-since-last-query-in-seconds": "integer",
"location": "integer",
"subscriber-id": "string",
"is-ip-enabled": "boolean",
"router-uptime-in-seconds": "integer",
"parent-ifhandle": "string",
"query-interval": "integer",
"configuration-mcast-vrf-error": "boolean",
"is-identity-present": "boolean",
"query-timeout": "integer",
"query-maximum-response-time": "integer",
"querier-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"igmp-version": "integer",
"las-ll-registration-count": "integer",
"is-interface-up": "boolean",
"mte-tuple-count": "integer",
"is-las-request": "boolean",
"prefix-length": "integer",
"las-null-update-count": "integer",
"is-querier": "boolean",
"robustness": "integer",
"las-unregistration-count": "integer",
"is-im-state-registered": "boolean",
"mtu": "integer",
"is-configurationverify": "boolean",
"time-since-last-report-in-seconds": "integer",
"configurationvrf-error": "boolean",
"host-version": "integer",
"group-joins": "integer"
}
]
}
}
IFRS-INTERFACE-SUMMARY:
Common node of vrf, default-context
- ifrs-interface-summary: IGMP-EDM-IDB-SUMM-BAG
-
IGMP IFRS Interface summary
Example
{
"ifrs-interface-summary": {
"interface-count": "integer",
"configuration-count": "integer"
}
}
NON-ACTIVE-GROUPS:
Common node of vrf, default-context
- non-active-groups: IGMP-EDM-NOT-ACTIVE-ALLGROUPS-BAG
-
IGMP Non-Active Groups Information
Example
{
"non-active-groups": {
"non-active-groups": [
{
"interface": "string",
"group-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"reason-for-non-activity": "string",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
}
}
IGMP-EDM-INTF-SUMMARY-BAG:
IGMP interface summary info
- group-count: integer
-
Current groups accepted per interface
- parent-ifhandle: string
-
Parent if handle
- router-uptime-in-seconds: integer
-
Time elapsed since router enabled event
- interface-name: string
-
Interface
- group-limit: integer
-
Maximum groups accepted per interface
- on-off: boolean
-
Enabled/Disabled
- time-since-last-report-in-seconds: integer
-
Time elapsed since last report
- time-since-last-query-in-seconds: integer
-
Time elapsed since last query
Example
{
"group-count": "integer",
"parent-ifhandle": "string",
"router-uptime-in-seconds": "integer",
"interface-name": "string",
"group-limit": "integer",
"on-off": "boolean",
"time-since-last-report-in-seconds": "integer",
"time-since-last-query-in-seconds": "integer"
}
EXPLICIT-GROUP-TABLE:
Common node of vrf, default-context
- explicit-groups: object
-
IGMP Explicit Group Database
Example
{
"explicit-groups": {
"explicit-group": [
{
"group-address": "string",
"interface-name": "string",
"source-address": "string",
"exclude-hosts": "integer",
"host": [
{
"uptime": "integer",
"source-address": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"is-exclude": "boolean",
"expiration-time": "integer",
"source-count": "integer",
"address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
],
"include-hosts": "integer",
"group-info": {
"uptime": "integer",
"older-host-version1-timer": "integer",
"row-status": "string",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-added": "boolean",
"older-host-version2-timer": "integer",
"last-reporter": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"expiration-time": "string",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-suppressed": "boolean",
"is-self-join": "boolean",
"is-low-memory": "boolean",
"interface-name-xr": "string",
"router-filter-mode": "integer",
"explicit-tracking-enabled": "boolean"
}
}
]
}
}
GLOBAL-INTERFACE-TABLE:
Common node of vrf, default-context
- global-interface-table: INTERFACE
-
IGMP Global Interface
Example
{
"global-interface-table": {
"interface": [
{
"interface-name": "string",
"las-ll-remove-update-count": "integer",
"las-ll-add-update-count": "integer",
"las-update-count": "integer",
"configurationvrf-set": "boolean",
"vrf-id": "integer",
"subscriber-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"vrf-state": "integer",
"last-member-query-interval": "integer",
"interface-name-xr": "string",
"is-las-registered": "boolean",
"group-leaves": "integer",
"is-router-enabled": "boolean",
"las-get-address-count": "integer",
"subscriber-mode": "integer",
"total-active-groups": "integer",
"configuration-mcast-vrf-set": "boolean",
"querier-uptime": "integer",
"proxy-interface": "string",
"is-subscriber": "boolean",
"mte-vrf-id": "integer",
"state": "string",
"time-since-last-query-in-seconds": "integer",
"location": "integer",
"subscriber-id": "string",
"is-ip-enabled": "boolean",
"router-uptime-in-seconds": "integer",
"parent-ifhandle": "string",
"query-interval": "integer",
"configuration-mcast-vrf-error": "boolean",
"is-identity-present": "boolean",
"query-timeout": "integer",
"query-maximum-response-time": "integer",
"querier-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"igmp-version": "integer",
"las-ll-registration-count": "integer",
"is-interface-up": "boolean",
"mte-tuple-count": "integer",
"is-las-request": "boolean",
"prefix-length": "integer",
"las-null-update-count": "integer",
"is-querier": "boolean",
"robustness": "integer",
"las-unregistration-count": "integer",
"is-im-state-registered": "boolean",
"mtu": "integer",
"is-configurationverify": "boolean",
"time-since-last-report-in-seconds": "integer",
"configurationvrf-error": "boolean",
"host-version": "integer",
"group-joins": "integer"
}
]
}
}
IGMP-GROUP-RANGE:
IGMP Group-Map Range
- is-stale: boolean
-
Is the entry stale
- protocol: string no-route, sm, dm, bidir, ssm, any
-
Protocol
- prefix-length: integer
-
Prefix length
- group-address-xr: IGMP-ADDRTYPE
-
Group address
Example
{
"is-stale": "boolean",
"protocol": "string",
"prefix-length": "integer",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
SSM-MAP-DETAIL-TABLE:
Common node of vrf, default-context
- ssm-map-details: object
-
SSM Map Detail
Example
{
"ssm-map-details": {
"ssm-map-detail": [
{
"group-address": "string",
"ssm-map-type": "string",
"response-pending": "boolean",
"query-interval": "integer",
"map-info": {
"source-counts": "integer",
"map-type": "integer",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
},
"expiration-time": "integer",
"sources": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"elapsed-time": "integer"
}
]
}
}
INTERFACE-UNICAST-QOS-ADJUST-TABLE:
Common node of vrf, default-context
- interface-unicast-qos-adjusts: object
-
IGMP Interface Unicast-Qos-Adjust
Example
{
"interface-unicast-qos-adjusts": {
"interface-unicast-qos-adjust": [
{
"interface-name": "string",
"is-virtual-access": "boolean",
"rate": "integer",
"rate-increments": "integer",
"rate-decrements": "integer",
"update": [
{
"is-add": "boolean",
"group-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"received-time": "integer",
"weight": "integer",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
}
]
}
}
IGMP-EDM-I2Q-INTF-STATS-BAG:
IGMP-QOS Interface Stats
- is-virtual-access: boolean
-
Is VirtualAccess Interface
- rate: integer
-
Overall rate in Kbps
- rate-increments: integer
-
Count of rate increments
- rate-decrements: integer
-
Count of rate decrements
- update: IGMP-EDM-I2Q-INTF-RATE-BAG
-
List of updates
Example
{
"is-virtual-access": "boolean",
"rate": "integer",
"rate-increments": "integer",
"rate-decrements": "integer",
"update": [
{
"is-add": "boolean",
"group-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"received-time": "integer",
"weight": "integer",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
}
IGMP-EDM-NSF-BAG:
IGMP NSF state
- last-nsf-off: string
-
Last NSF time off
- last-icd-notif-recv-min: string
-
Last ICD Notif Recv in Seconds
- multicast-nsf-time-left: integer
-
Multicast NSF time remaining in secs
- is-multicast-nsf-active: boolean
-
Is Multicast NSF active
- last-icd-notif-recv: string
-
Last ICD Notif Recv
- multicast-nsf-timeout: integer
-
Multicast NSF timeout in secs
- respawn-count: integer
-
Respawn Count
- last-nsf-on-min: string
-
Last NSF time ON in Seconds
- last-nsf-on: string
-
Last NSF time ON
- last-nsf-off-min: string
-
Last NSF time OFF in Seconds
Example
{
"last-nsf-off": "string",
"last-icd-notif-recv-min": "string",
"multicast-nsf-time-left": "integer",
"is-multicast-nsf-active": "boolean",
"last-icd-notif-recv": "string",
"multicast-nsf-timeout": "integer",
"respawn-count": "integer",
"last-nsf-on-min": "string",
"last-nsf-on": "string",
"last-nsf-off-min": "string"
}
IGMP-EDM-BVI-STATS-BAG:
IGMP EDM BVI STATS BAG
- tx-unknown-mrouter-msg: integer
-
Number of IGMP Mrouter Unknown messages transmitted
- send-blocks: integer
-
Number of AIPC buffers send blocked
- tx-protocol-buffers: integer
-
Number of IGMP protocol buffers transmitted
- rx-ipc-close-notif: integer
-
Number of AIPC close notifications received
- rx-ipc-publish-notif: integer
-
Number of AIPC publish notifications received
- wtx-msg-proto-sent: integer
-
Number of WTX messages sent to Protocol
- rx-igmp-packet-success: integer
-
Number of IGMP protocol messages received
- rx-ipc-open-notif: integer
-
Number of AIPC open notifications received
- rx-sweep-mrouter-msg: integer
-
Number of IGMP Mrouter Sweep messages received
- rx-ipc-lwm-notif: integer
-
Number of AIPC LWM notifications received
- wtx-msg-drop-nomem: integer
-
Number of WTX messages dropped to memory
- rx-delete-mrouter-msg: integer
-
Number of IGMP Mrouter Delete messages received
- wtx-msg-freed: integer
-
Number of WTX messages freed
- rx-ipc-q-full-notif: integer
-
Number of AIPC queue full notifications received
- receive-buffers: integer
-
Number of AIPC buffers received
- rx-add-mrouter-msg: integer
-
Number of IGMP Mrouter Add messages received
- tx-add-mrouter-msg: integer
-
Number of IGMP Mrouter Add messages transmitted
- rx-ipc-input-wait-notif: integer
-
Number of AIPC input waiting notifications received
- tx-sweep-mrouter-msg: integer
-
Number of IGMP Mrouter Sweep messages received
- tx-unknown-buffers: integer
-
Number of IGMP Unknown buffers transmited
- rx-ipc-send-status-notif: integer
-
Number of AIPC send status notifications received
- rx-ipc-output-notif: integer
-
Number of AIPC output notifications received
- wtx-msg-drop-dc: integer
-
Number of WTX messages dropped due to disconnect
- null-buffer-handles: integer
-
Number of AIPC NULL buffer handles
- tx-delete-mrouter-msg: integer
-
Number of IGMP Mrouter Delete messages transmitted
- rx-ipc-error-notif: integer
-
Number of AIPC error notifications received
- rx-unknown-mrouter-msg: integer
-
Number of IGMP Mrouter Unknown messages received
- release-buffers: integer
-
Number of AIPC buffers released
- release-fail-buffers: integer
-
Number of AIPC buffers release failed
- tx-buffer-errors: integer
-
Number of AIPC transmission errors
- tx-mrouter-buffers: integer
-
Number of IGMP Mrouter buffers transmitted
- tx-buffers: integer
-
Number of AIPC buffers transmited
- wtx-msg-recvd: integer
-
Number of WTX messages received
- wtx-msg-sent: integer
-
Number of WTX messages sent
- rx-ipc-connect-notif: integer
-
Number of AIPC connect notifications received
Example
{
"tx-unknown-mrouter-msg": "integer",
"send-blocks": "integer",
"tx-protocol-buffers": "integer",
"rx-ipc-close-notif": "integer",
"rx-ipc-publish-notif": "integer",
"wtx-msg-proto-sent": "integer",
"rx-igmp-packet-success": "integer",
"rx-ipc-open-notif": "integer",
"rx-sweep-mrouter-msg": "integer",
"rx-ipc-lwm-notif": "integer",
"wtx-msg-drop-nomem": "integer",
"rx-delete-mrouter-msg": "integer",
"wtx-msg-freed": "integer",
"rx-ipc-q-full-notif": "integer",
"receive-buffers": "integer",
"rx-add-mrouter-msg": "integer",
"tx-add-mrouter-msg": "integer",
"rx-ipc-input-wait-notif": "integer",
"tx-sweep-mrouter-msg": "integer",
"tx-unknown-buffers": "integer",
"rx-ipc-send-status-notif": "integer",
"rx-ipc-output-notif": "integer",
"wtx-msg-drop-dc": "integer",
"null-buffer-handles": "integer",
"tx-delete-mrouter-msg": "integer",
"rx-ipc-error-notif": "integer",
"rx-unknown-mrouter-msg": "integer",
"release-buffers": "integer",
"release-fail-buffers": "integer",
"tx-buffer-errors": "integer",
"tx-mrouter-buffers": "integer",
"tx-buffers": "integer",
"wtx-msg-recvd": "integer",
"wtx-msg-sent": "integer",
"rx-ipc-connect-notif": "integer"
}
SUMMARY:
Common node of vrf, default-context
- summary: IGMP-EDM-SUMMARY-BAG
-
IGMP Summary Information
Example
{
"summary": {
"group-count": "integer",
"disabled-interface-count": "integer",
"group-limit": "integer",
"supported-interfaces": "integer",
"robustness": "integer",
"is-disabled": "boolean",
"enabled-interface-count": "integer",
"node-low-memory": "boolean",
"unsupported-interfaces": "integer",
"tunnel-mte-config-count": "integer",
"interface": [
{
"group-count": "integer",
"parent-ifhandle": "string",
"router-uptime-in-seconds": "integer",
"interface-name": "string",
"group-limit": "integer",
"on-off": "boolean",
"time-since-last-report-in-seconds": "integer",
"time-since-last-query-in-seconds": "integer"
}
]
}
}
GROUP-TABLE:
Common node of vrf, default-context
- groups: object
-
IGMP Group Database Table
Example
{
"groups": {
"group": [
{
"group-address": "string",
"interface-name": "string",
"uptime": "integer",
"older-host-version1-timer": "integer",
"row-status": "string",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-added": "boolean",
"older-host-version2-timer": "integer",
"last-reporter": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"expiration-time": "string",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-suppressed": "boolean",
"is-self-join": "boolean",
"is-low-memory": "boolean",
"interface-name-xr": "string",
"router-filter-mode": "integer",
"explicit-tracking-enabled": "boolean"
}
]
}
}
IGMP-EDM-SSM-MAP-DETAIL-BAG:
IGMP SSM Map Detail List
- response-pending: boolean
-
Response Pending
- query-interval: integer
-
Query interval
- map-info: IGMP-EDM-SSM-MAP-BAG
-
Basic Map Info
- expiration-time: integer
-
Expiration Time in Seconds
- sources: IGMP-ADDRTYPE
-
List of sources
- elapsed-time: integer
-
Elapsed time
Example
{
"response-pending": "boolean",
"query-interval": "integer",
"map-info": {
"source-counts": "integer",
"map-type": "integer",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
},
"expiration-time": "integer",
"sources": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"elapsed-time": "integer"
}
DETAIL-GROUP-TABLE:
Common node of vrf, default-context
- detail-groups: object
-
IGMP Detail Group Database
Example
{
"detail-groups": {
"detail-group": [
{
"group-address": "string",
"interface-name": "string",
"source-address": "string",
"source": [
{
"uptime": "integer",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"expiration-time": "string",
"is-local": "boolean",
"is-forward": "boolean",
"is-added": "boolean",
"flags": "string",
"is-remote": "boolean",
"is-we-report": "boolean"
}
],
"is-router-exclude-mode": "boolean",
"group-info": {
"uptime": "integer",
"older-host-version1-timer": "integer",
"row-status": "string",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-added": "boolean",
"older-host-version2-timer": "integer",
"last-reporter": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"expiration-time": "string",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-suppressed": "boolean",
"is-self-join": "boolean",
"is-low-memory": "boolean",
"interface-name-xr": "string",
"router-filter-mode": "integer",
"explicit-tracking-enabled": "boolean"
},
"is-host-exclude-mode": "boolean"
}
]
}
}
AMT-GW-BAG:
AMT GW info
- amt-nonce: integer
-
Nonce
- amtgw: string
-
GW
- mem-upd-in: integer
-
UpdIn
- key-len: integer
-
Len
- mem-upd-out: integer
-
UpdOut
- amtnh: integer
-
AMT NH
- amt-port: integer
-
Port
- idb: integer
-
IDB
Example
{
"amt-nonce": "integer",
"amtgw": "string",
"mem-upd-in": "integer",
"key-len": "integer",
"mem-upd-out": "integer",
"amtnh": "integer",
"amt-port": "integer",
"idb": "integer"
}
ACTIVE:
Common node of igmp, mld
- active: DEFAULT-CONTEXT
-
Active Process
Example
{
"active": {
"default-context": {
"interface-state-offs": {
"interface-state-off": [
{
"interface-name": "string",
"las-ll-remove-update-count": "integer",
"las-ll-add-update-count": "integer",
"las-update-count": "integer",
"configurationvrf-set": "boolean",
"vrf-id": "integer",
"subscriber-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"vrf-state": "integer",
"last-member-query-interval": "integer",
"interface-name-xr": "string",
"is-las-registered": "boolean",
"group-leaves": "integer",
"is-router-enabled": "boolean",
"las-get-address-count": "integer",
"subscriber-mode": "integer",
"total-active-groups": "integer",
"configuration-mcast-vrf-set": "boolean",
"querier-uptime": "integer",
"proxy-interface": "string",
"is-subscriber": "boolean",
"mte-vrf-id": "integer",
"state": "string",
"time-since-last-query-in-seconds": "integer",
"location": "integer",
"subscriber-id": "string",
"is-ip-enabled": "boolean",
"router-uptime-in-seconds": "integer",
"parent-ifhandle": "string",
"query-interval": "integer",
"configuration-mcast-vrf-error": "boolean",
"is-identity-present": "boolean",
"query-timeout": "integer",
"query-maximum-response-time": "integer",
"querier-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"igmp-version": "integer",
"las-ll-registration-count": "integer",
"is-interface-up": "boolean",
"mte-tuple-count": "integer",
"is-las-request": "boolean",
"prefix-length": "integer",
"las-null-update-count": "integer",
"is-querier": "boolean",
"robustness": "integer",
"las-unregistration-count": "integer",
"is-im-state-registered": "boolean",
"mtu": "integer",
"is-configurationverify": "boolean",
"time-since-last-report-in-seconds": "integer",
"configurationvrf-error": "boolean",
"host-version": "integer",
"group-joins": "integer"
}
]
}
}
}
}
IGMP-EDM-IDB-IFRS-BAG:
IGMP IFRS interface entry
- join-group-count: integer
-
Join group count
- igmp-interface-entry: IGMP-EDM-IDB-BAG
-
IGMP interface entry
Example
{
"join-group-count": "integer",
"igmp-interface-entry": {
"las-ll-remove-update-count": "integer",
"las-ll-add-update-count": "integer",
"las-update-count": "integer",
"configurationvrf-set": "boolean",
"vrf-id": "integer",
"subscriber-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"vrf-state": "integer",
"last-member-query-interval": "integer",
"interface-name-xr": "string",
"is-las-registered": "boolean",
"group-leaves": "integer",
"is-router-enabled": "boolean",
"las-get-address-count": "integer",
"subscriber-mode": "integer",
"total-active-groups": "integer",
"configuration-mcast-vrf-set": "boolean",
"querier-uptime": "integer",
"proxy-interface": "string",
"is-subscriber": "boolean",
"mte-vrf-id": "integer",
"state": "string",
"time-since-last-query-in-seconds": "integer",
"location": "integer",
"subscriber-id": "string",
"is-ip-enabled": "boolean",
"router-uptime-in-seconds": "integer",
"parent-ifhandle": "string",
"query-interval": "integer",
"configuration-mcast-vrf-error": "boolean",
"is-identity-present": "boolean",
"query-timeout": "integer",
"query-maximum-response-time": "integer",
"querier-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"igmp-version": "integer",
"las-ll-registration-count": "integer",
"is-interface-up": "boolean",
"mte-tuple-count": "integer",
"is-las-request": "boolean",
"prefix-length": "integer",
"las-null-update-count": "integer",
"is-querier": "boolean",
"robustness": "integer",
"las-unregistration-count": "integer",
"is-im-state-registered": "boolean",
"mtu": "integer",
"is-configurationverify": "boolean",
"time-since-last-report-in-seconds": "integer",
"configurationvrf-error": "boolean",
"host-version": "integer",
"group-joins": "integer"
}
}
DEFAULT-CONTEXT:
Common node of active, standby
- default-context: INTERFACE-STATE-OFF-TABLE
-
Default Context
Example
{
"default-context": {
"interface-state-offs": {
"interface-state-off": [
{
"interface-name": "string",
"las-ll-remove-update-count": "integer",
"las-ll-add-update-count": "integer",
"las-update-count": "integer",
"configurationvrf-set": "boolean",
"vrf-id": "integer",
"subscriber-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"vrf-state": "integer",
"last-member-query-interval": "integer",
"interface-name-xr": "string",
"is-las-registered": "boolean",
"group-leaves": "integer",
"is-router-enabled": "boolean",
"las-get-address-count": "integer",
"subscriber-mode": "integer",
"total-active-groups": "integer",
"configuration-mcast-vrf-set": "boolean",
"querier-uptime": "integer",
"proxy-interface": "string",
"is-subscriber": "boolean",
"mte-vrf-id": "integer",
"state": "string",
"time-since-last-query-in-seconds": "integer",
"location": "integer",
"subscriber-id": "string",
"is-ip-enabled": "boolean",
"router-uptime-in-seconds": "integer",
"parent-ifhandle": "string",
"query-interval": "integer",
"configuration-mcast-vrf-error": "boolean",
"is-identity-present": "boolean",
"query-timeout": "integer",
"query-maximum-response-time": "integer",
"querier-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"igmp-version": "integer",
"las-ll-registration-count": "integer",
"is-interface-up": "boolean",
"mte-tuple-count": "integer",
"is-las-request": "boolean",
"prefix-length": "integer",
"las-null-update-count": "integer",
"is-querier": "boolean",
"robustness": "integer",
"las-unregistration-count": "integer",
"is-im-state-registered": "boolean",
"mtu": "integer",
"is-configurationverify": "boolean",
"time-since-last-report-in-seconds": "integer",
"configurationvrf-error": "boolean",
"host-version": "integer",
"group-joins": "integer"
}
]
}
}
}
GROUP-SUMMARY:
Common node of vrf, default-context
- group-summary: IGMP-EDM-GROUPS-SUMMARY-BAG
-
IGMP Groups Summary
Example
{
"group-summary": {
"group-count": "integer",
"groutes": "integer",
"sg-routes": "integer",
"is-low-memory": "boolean"
}
}
AMT-SUMMARY-BAG:
AMT summary info
- gateway-count: integer
-
Number of AMT Gateway
- prefix-length: integer
-
Advertize AMT prefix length
- anycast-prefix: string
-
Robustness variable
- query-interval: integer
-
AMT Query interval
- relay-address: string
-
Advertaisment for AMT Relay address
- tos: integer
-
Type Of Service value in AMT header
- mtu: integer
-
AMT Tunnel MTU
- tunnel-count: integer
-
AMT Tunnel Count
- tunnel-configured-maximum: integer
-
AMT Tunnel configured Maximum
- ttl: integer
-
Time To Live value in AMT header
- is-acl-configured: boolean
-
ACL configured under AMT
- max-gateway: integer
-
Maximum Gateway allowed
- is-gateway-simulation: boolean
-
AMT Gateway Simulation
- is-ou-of-resource: boolean
-
AMT Out Of Resource
Example
{
"gateway-count": "integer",
"prefix-length": "integer",
"anycast-prefix": "string",
"query-interval": "integer",
"relay-address": "string",
"tos": "integer",
"mtu": "integer",
"tunnel-count": "integer",
"tunnel-configured-maximum": "integer",
"ttl": "integer",
"is-acl-configured": "boolean",
"max-gateway": "integer",
"is-gateway-simulation": "boolean",
"is-ou-of-resource": "boolean"
}
PROCESS:
Common node of active, standby
- process: object
-
Process
Example
{
"process": {
"amt-gateways": {
"amt-gateway": [
{
"gateway-address": "string",
"port": "integer",
"amt-nonce": "integer",
"amtgw": "string",
"mem-upd-in": "integer",
"key-len": "integer",
"mem-upd-out": "integer",
"amtnh": "integer",
"amt-port": "integer",
"idb": "integer"
}
]
},
"unicast-qos-adjust-stats": {
"is-qos-s-sweeped": "boolean",
"batches": "integer",
"send-errors": "integer",
"last-download-time": "integer",
"sent-resync-bulks": "integer",
"is-resync-required": "boolean",
"queues": "integer",
"is-resync-start-sent": "boolean",
"send-partial-errors": "integer",
"last-sweep-time": "integer",
"send-success": "integer",
"is-resync-received": "boolean",
"add-to-batches": "integer",
"received-resync-requests": "integer",
"send-comm-errors": "integer",
"delete-to-batches": "integer"
},
"amt-summary": {
"gateway-count": "integer",
"prefix-length": "integer",
"anycast-prefix": "string",
"query-interval": "integer",
"relay-address": "string",
"tos": "integer",
"mtu": "integer",
"tunnel-count": "integer",
"tunnel-configured-maximum": "integer",
"ttl": "integer",
"is-acl-configured": "boolean",
"max-gateway": "integer",
"is-gateway-simulation": "boolean",
"is-ou-of-resource": "boolean"
},
"nsf": {
"last-nsf-off": "string",
"last-icd-notif-recv-min": "string",
"multicast-nsf-time-left": "integer",
"is-multicast-nsf-active": "boolean",
"last-icd-notif-recv": "string",
"multicast-nsf-timeout": "integer",
"respawn-count": "integer",
"last-nsf-on-min": "string",
"last-nsf-on": "string",
"last-nsf-off-min": "string"
},
"bvi-statistics": {
"tx-unknown-mrouter-msg": "integer",
"send-blocks": "integer",
"tx-protocol-buffers": "integer",
"rx-ipc-close-notif": "integer",
"rx-ipc-publish-notif": "integer",
"wtx-msg-proto-sent": "integer",
"rx-igmp-packet-success": "integer",
"rx-ipc-open-notif": "integer",
"rx-sweep-mrouter-msg": "integer",
"rx-ipc-lwm-notif": "integer",
"wtx-msg-drop-nomem": "integer",
"rx-delete-mrouter-msg": "integer",
"wtx-msg-freed": "integer",
"rx-ipc-q-full-notif": "integer",
"receive-buffers": "integer",
"rx-add-mrouter-msg": "integer",
"tx-add-mrouter-msg": "integer",
"rx-ipc-input-wait-notif": "integer",
"tx-sweep-mrouter-msg": "integer",
"tx-unknown-buffers": "integer",
"rx-ipc-send-status-notif": "integer",
"rx-ipc-output-notif": "integer",
"wtx-msg-drop-dc": "integer",
"null-buffer-handles": "integer",
"tx-delete-mrouter-msg": "integer",
"rx-ipc-error-notif": "integer",
"rx-unknown-mrouter-msg": "integer",
"release-buffers": "integer",
"release-fail-buffers": "integer",
"tx-buffer-errors": "integer",
"tx-mrouter-buffers": "integer",
"tx-buffers": "integer",
"wtx-msg-recvd": "integer",
"wtx-msg-sent": "integer"
}
}
}
IGMP-EDM-I2Q-INTF-RATE-BAG:
IGMP-QOS Interface Rate
- is-add: boolean
-
Is this a rate increment
- group-address: IGMP-ADDRTYPE
-
Group address
- received-time: integer
-
Time this update is received
- weight: integer
-
Weight from policy
- source-address: IGMP-ADDRTYPE
-
Source address
Example
{
"is-add": "boolean",
"group-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"received-time": "integer",
"weight": "integer",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
IGMP-ADDRTYPE:
IGMP ADDRTYPE
- af-name: string ipv4-unicast, ipv6-unicast
-
AFName
- ipv6-address: string
-
IPV6 Addr
- ipv4-address: string
-
IPv4 Addr
Example
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
IGMP-EDM-IDB-BAG:
IGMP interface entry
- las-ll-remove-update-count: integer
-
LAS LL remove update count
- las-ll-add-update-count: integer
-
LAS LL add update count
- las-update-count: integer
-
LAS Update count
- configurationvrf-set: boolean
-
CFG vrf set
- vrf-id: integer
-
VRF id
- subscriber-address: IGMP-ADDRTYPE
-
Address of subscriber
- vrf-state: integer
-
Vrf State
- last-member-query-interval: integer
-
Last Member Query Interval
- interface-name-xr: string
-
Interface
- is-las-registered: boolean
-
LAS registered
- group-leaves: integer
-
No. of group leaves
- is-router-enabled: boolean
-
Is Router functionality enabled
- las-get-address-count: integer
-
LAS get addr count
- subscriber-mode: integer
-
Subscriber mode
- total-active-groups: integer
-
Actual number of groups on interface
- configuration-mcast-vrf-set: boolean
-
Is mcast set
- querier-uptime: integer
-
Time since the last querier took over
- proxy-interface: string
-
Proxy interface index
- is-subscriber: boolean
-
Subscriber interface
- mte-vrf-id: integer
-
MTE VRF id
- state: string
-
Interface state
- time-since-last-query-in-seconds: integer
-
Time elapsed since last query
- location: integer
-
Location
- subscriber-id: string
-
ID string of subscriber
- is-ip-enabled: boolean
-
Is IP enabled
- router-uptime-in-seconds: integer
-
Uptime since router enabled event
- parent-ifhandle: string
-
Parent If Handle
- query-interval: integer
-
Query Interval value in seconds
- configuration-mcast-vrf-error: boolean
-
Is mcast error
- is-identity-present: boolean
-
Subscriber ID or Address available from AAA
- query-timeout: integer
-
Query Timeout value
- query-maximum-response-time: integer
-
Max Response Timeout value
- querier-address: IGMP-ADDRTYPE
-
Address of the Querier
- address: IGMP-ADDRTYPE
-
IP address
- igmp-version: integer
-
IGMP Router version
- las-ll-registration-count: integer
-
LAS reg count
- is-interface-up: boolean
-
Is interface up
- mte-tuple-count: integer
-
MTE Tuple count
- is-las-request: boolean
-
LAS req
- prefix-length: integer
-
Prefix length
- las-null-update-count: integer
-
LAS Null update count
- is-querier: boolean
-
Are we querier
- robustness: integer
-
Robustness Variable value
- las-unregistration-count: integer
-
LAS unreg count
- is-im-state-registered: boolean
-
Im state registered
- mtu: integer
-
MTU
- is-configurationverify: boolean
-
CFG verify
- time-since-last-report-in-seconds: integer
-
Time elapsed since last report
- configurationvrf-error: boolean
-
CFG vrf error
- host-version: integer
-
IGMP Host version
- group-joins: integer
-
No. of group joins
Example
{
"las-ll-remove-update-count": "integer",
"las-ll-add-update-count": "integer",
"las-update-count": "integer",
"configurationvrf-set": "boolean",
"vrf-id": "integer",
"subscriber-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"vrf-state": "integer",
"last-member-query-interval": "integer",
"interface-name-xr": "string",
"is-las-registered": "boolean",
"group-leaves": "integer",
"is-router-enabled": "boolean",
"las-get-address-count": "integer",
"subscriber-mode": "integer",
"total-active-groups": "integer",
"configuration-mcast-vrf-set": "boolean",
"querier-uptime": "integer",
"proxy-interface": "string",
"is-subscriber": "boolean",
"mte-vrf-id": "integer",
"state": "string",
"time-since-last-query-in-seconds": "integer",
"location": "integer",
"subscriber-id": "string",
"is-ip-enabled": "boolean",
"router-uptime-in-seconds": "integer",
"parent-ifhandle": "string",
"query-interval": "integer",
"configuration-mcast-vrf-error": "boolean",
"is-identity-present": "boolean",
"query-timeout": "integer",
"query-maximum-response-time": "integer",
"querier-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"igmp-version": "integer",
"las-ll-registration-count": "integer",
"is-interface-up": "boolean",
"mte-tuple-count": "integer",
"is-las-request": "boolean",
"prefix-length": "integer",
"las-null-update-count": "integer",
"is-querier": "boolean",
"robustness": "integer",
"las-unregistration-count": "integer",
"is-im-state-registered": "boolean",
"mtu": "integer",
"is-configurationverify": "boolean",
"time-since-last-report-in-seconds": "integer",
"configurationvrf-error": "boolean",
"host-version": "integer",
"group-joins": "integer"
}
IGMP-EDM-SUMMARY-BAG:
IGMP summary info
- group-count: integer
-
Current groups accepted
- disabled-interface-count: integer
-
No. of disabled interfaces
- group-limit: integer
-
Maximum groups accepted
- supported-interfaces: integer
-
No. of supported interfaces
- robustness: integer
-
Robustness variable
- is-disabled: boolean
-
Is maximum enforcement disabled
- enabled-interface-count: integer
-
No. of enabled interfaces
- node-low-memory: boolean
-
Is node in low memory condition
- unsupported-interfaces: integer
-
No. of unsupported interfaces
- tunnel-mte-config-count: integer
-
No. of static group commands
- interface: IGMP-EDM-INTF-SUMMARY-BAG
-
Maximum and current groups accepted for each interface
Example
{
"group-count": "integer",
"disabled-interface-count": "integer",
"group-limit": "integer",
"supported-interfaces": "integer",
"robustness": "integer",
"is-disabled": "boolean",
"enabled-interface-count": "integer",
"node-low-memory": "boolean",
"unsupported-interfaces": "integer",
"tunnel-mte-config-count": "integer",
"interface": [
{
"group-count": "integer",
"parent-ifhandle": "string",
"router-uptime-in-seconds": "integer",
"interface-name": "string",
"group-limit": "integer",
"on-off": "boolean",
"time-since-last-report-in-seconds": "integer",
"time-since-last-query-in-seconds": "integer"
}
]
}
IGMP-EDM-GROUPS-BAG:
IGMP group entry
- uptime: integer
-
Uptime in seconds
- older-host-version1-timer: integer
-
IGMP Hostversion1timer
- row-status: string
-
interface on or off for the group
- source-address: IGMP-ADDRTYPE
-
Source Address
- is-added: boolean
-
Joined
- older-host-version2-timer: integer
-
IGMP Hostversion2timer
- last-reporter: IGMP-ADDRTYPE
-
Last reporter address
- expiration-time: string
-
Expiration time in seconds
- group-address-xr: IGMP-ADDRTYPE
-
Group Address
- is-suppressed: boolean
-
Suppressed
- is-self-join: boolean
-
If local system is member of this group on this interface
- is-low-memory: boolean
-
Node is running low on memory
- interface-name-xr: string
-
Interface
- router-filter-mode: integer
-
Filter mode
- explicit-tracking-enabled: boolean
-
Is explicit tracking enabled
Example
{
"uptime": "integer",
"older-host-version1-timer": "integer",
"row-status": "string",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-added": "boolean",
"older-host-version2-timer": "integer",
"last-reporter": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"expiration-time": "string",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-suppressed": "boolean",
"is-self-join": "boolean",
"is-low-memory": "boolean",
"interface-name-xr": "string",
"router-filter-mode": "integer",
"explicit-tracking-enabled": "boolean"
}
IGMP-EDM-GROUPS-SUMMARY-BAG:
IGMP group summary entry
- group-count: integer
-
Current groups accepted
- groutes: integer
-
No. of (*,G) routes
- sg-routes: integer
-
No. of (S,G) routes
- is-low-memory: boolean
-
Node is running low on memory
Example
{
"group-count": "integer",
"groutes": "integer",
"sg-routes": "integer",
"is-low-memory": "boolean"
}
INTERFACE-STATE-ON-TABLE:
Common node of vrf, default-context
- interface-state-ons: object
-
IGMP Interface state on
Example
{
"interface-state-ons": {
"interface-state-on": [
{
"interface-name": "string",
"las-ll-remove-update-count": "integer",
"las-ll-add-update-count": "integer",
"las-update-count": "integer",
"configurationvrf-set": "boolean",
"vrf-id": "integer",
"subscriber-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"vrf-state": "integer",
"last-member-query-interval": "integer",
"interface-name-xr": "string",
"is-las-registered": "boolean",
"group-leaves": "integer",
"is-router-enabled": "boolean",
"las-get-address-count": "integer",
"subscriber-mode": "integer",
"total-active-groups": "integer",
"configuration-mcast-vrf-set": "boolean",
"querier-uptime": "integer",
"proxy-interface": "string",
"is-subscriber": "boolean",
"mte-vrf-id": "integer",
"state": "string",
"time-since-last-query-in-seconds": "integer",
"location": "integer",
"subscriber-id": "string",
"is-ip-enabled": "boolean",
"router-uptime-in-seconds": "integer",
"parent-ifhandle": "string",
"query-interval": "integer",
"configuration-mcast-vrf-error": "boolean",
"is-identity-present": "boolean",
"query-timeout": "integer",
"query-maximum-response-time": "integer",
"querier-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"igmp-version": "integer",
"las-ll-registration-count": "integer",
"is-interface-up": "boolean",
"mte-tuple-count": "integer",
"is-las-request": "boolean",
"prefix-length": "integer",
"las-null-update-count": "integer",
"is-querier": "boolean",
"robustness": "integer",
"las-unregistration-count": "integer",
"is-im-state-registered": "boolean",
"mtu": "integer",
"is-configurationverify": "boolean",
"time-since-last-report-in-seconds": "integer",
"configurationvrf-error": "boolean",
"host-version": "integer",
"group-joins": "integer"
}
]
}
}
IGMP-EDM-IDB-SUMM-BAG:
IGMP Interface DB summary
- interface-count: integer
-
Interface Count
- configuration-count: integer
-
Configuration count
Example
{
"interface-count": "integer",
"configuration-count": "integer"
}
INTERFACE:
Common node of interface-table, global-interface-table
- interface: object[]
-
IGMP Interface
Example
{
"interface": [
{
"interface-name": "string",
"las-ll-remove-update-count": "integer",
"las-ll-add-update-count": "integer",
"las-update-count": "integer",
"configurationvrf-set": "boolean",
"vrf-id": "integer",
"subscriber-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"vrf-state": "integer",
"last-member-query-interval": "integer",
"interface-name-xr": "string",
"is-las-registered": "boolean",
"group-leaves": "integer",
"is-router-enabled": "boolean",
"las-get-address-count": "integer",
"subscriber-mode": "integer",
"total-active-groups": "integer",
"configuration-mcast-vrf-set": "boolean",
"querier-uptime": "integer",
"proxy-interface": "string",
"is-subscriber": "boolean",
"mte-vrf-id": "integer",
"state": "string",
"time-since-last-query-in-seconds": "integer",
"location": "integer",
"subscriber-id": "string",
"is-ip-enabled": "boolean",
"router-uptime-in-seconds": "integer",
"parent-ifhandle": "string",
"query-interval": "integer",
"configuration-mcast-vrf-error": "boolean",
"is-identity-present": "boolean",
"query-timeout": "integer",
"query-maximum-response-time": "integer",
"querier-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"igmp-version": "integer",
"las-ll-registration-count": "integer",
"is-interface-up": "boolean",
"mte-tuple-count": "integer",
"is-las-request": "boolean",
"prefix-length": "integer",
"las-null-update-count": "integer",
"is-querier": "boolean",
"robustness": "integer",
"las-unregistration-count": "integer",
"is-im-state-registered": "boolean",
"mtu": "integer",
"is-configurationverify": "boolean",
"time-since-last-report-in-seconds": "integer",
"configurationvrf-error": "boolean",
"host-version": "integer",
"group-joins": "integer"
}
]
}
IGMP-EDM-NOT-ACTIVE-ALLGROUPS-BAG:
IGMP Non active groups list
- non-active-groups: IGMP-EDM-NOT-ACTIVE-GROUP-BAG
-
List of non-active groups
Example
{
"non-active-groups": [
{
"interface": "string",
"group-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"reason-for-non-activity": "string",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
}
IGMP-EDM-GROUPS-HOST-BAG:
IGMP Groups host entry
- uptime: integer
-
Uptime in seconds
- source-address: IGMP-ADDRTYPE
-
First 3 source addresses
- is-exclude: boolean
-
Exclude flag set
- expiration-time: integer
-
Expiration time in seconds
- source-count: integer
-
No. of sources in entry
- address: IGMP-ADDRTYPE
-
Host Address
Example
{
"uptime": "integer",
"source-address": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"is-exclude": "boolean",
"expiration-time": "integer",
"source-count": "integer",
"address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
vrfs_schema:
VRF Table
- vrf: INTERFACE-STATE-OFF-TABLE
-
VRF table Names
Example
{
"vrf": [
{
"interface-state-offs": {
"interface-state-off": [
{
"interface-name": "string",
"las-ll-remove-update-count": "integer",
"las-ll-add-update-count": "integer",
"las-update-count": "integer",
"configurationvrf-set": "boolean",
"vrf-id": "integer",
"subscriber-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"vrf-state": "integer",
"last-member-query-interval": "integer",
"interface-name-xr": "string",
"is-las-registered": "boolean",
"group-leaves": "integer",
"is-router-enabled": "boolean",
"las-get-address-count": "integer",
"subscriber-mode": "integer",
"total-active-groups": "integer",
"configuration-mcast-vrf-set": "boolean",
"querier-uptime": "integer",
"proxy-interface": "string",
"is-subscriber": "boolean",
"mte-vrf-id": "integer",
"state": "string",
"time-since-last-query-in-seconds": "integer",
"location": "integer",
"subscriber-id": "string",
"is-ip-enabled": "boolean",
"router-uptime-in-seconds": "integer",
"parent-ifhandle": "string",
"query-interval": "integer",
"configuration-mcast-vrf-error": "boolean",
"is-identity-present": "boolean",
"query-timeout": "integer",
"query-maximum-response-time": "integer",
"querier-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"igmp-version": "integer",
"las-ll-registration-count": "integer",
"is-interface-up": "boolean",
"mte-tuple-count": "integer",
"is-las-request": "boolean",
"prefix-length": "integer",
"las-null-update-count": "integer",
"is-querier": "boolean",
"robustness": "integer",
"las-unregistration-count": "integer",
"is-im-state-registered": "boolean",
"mtu": "integer",
"is-configurationverify": "boolean",
"time-since-last-report-in-seconds": "integer",
"configurationvrf-error": "boolean",
"host-version": "integer",
"group-joins": "integer"
}
]
}
}
]
}
interface-state-ons_schema:
IGMP Interface state on
- interface-state-on: IGMP-EDM-IDB-BAG
-
IGMP Interface
Example
{
"interface-state-on": [
{
"las-ll-remove-update-count": "integer",
"las-ll-add-update-count": "integer",
"las-update-count": "integer",
"configurationvrf-set": "boolean",
"vrf-id": "integer",
"subscriber-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"vrf-state": "integer",
"last-member-query-interval": "integer",
"interface-name-xr": "string",
"is-las-registered": "boolean",
"group-leaves": "integer",
"is-router-enabled": "boolean",
"las-get-address-count": "integer",
"subscriber-mode": "integer",
"total-active-groups": "integer",
"configuration-mcast-vrf-set": "boolean",
"querier-uptime": "integer",
"proxy-interface": "string",
"is-subscriber": "boolean",
"mte-vrf-id": "integer",
"state": "string",
"time-since-last-query-in-seconds": "integer",
"location": "integer",
"subscriber-id": "string",
"is-ip-enabled": "boolean",
"router-uptime-in-seconds": "integer",
"parent-ifhandle": "string",
"query-interval": "integer",
"configuration-mcast-vrf-error": "boolean",
"is-identity-present": "boolean",
"query-timeout": "integer",
"query-maximum-response-time": "integer",
"querier-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"igmp-version": "integer",
"las-ll-registration-count": "integer",
"is-interface-up": "boolean",
"mte-tuple-count": "integer",
"is-las-request": "boolean",
"prefix-length": "integer",
"las-null-update-count": "integer",
"is-querier": "boolean",
"robustness": "integer",
"las-unregistration-count": "integer",
"is-im-state-registered": "boolean",
"mtu": "integer",
"is-configurationverify": "boolean",
"time-since-last-report-in-seconds": "integer",
"configurationvrf-error": "boolean",
"host-version": "integer",
"group-joins": "integer"
}
]
}
detail-groups_schema:
IGMP Detail Group Database
- detail-group: IGMP-EDM-GROUPS-DETAIL-BAG
-
IGMP Detail Group Entry Information
Example
{
"detail-group": [
{
"source": [
{
"uptime": "integer",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"expiration-time": "string",
"is-local": "boolean",
"is-forward": "boolean",
"is-added": "boolean",
"flags": "string",
"is-remote": "boolean",
"is-we-report": "boolean"
}
],
"is-router-exclude-mode": "boolean",
"group-info": {
"uptime": "integer",
"older-host-version1-timer": "integer",
"row-status": "string",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-added": "boolean",
"older-host-version2-timer": "integer",
"last-reporter": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"expiration-time": "string",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-suppressed": "boolean",
"is-self-join": "boolean",
"is-low-memory": "boolean",
"interface-name-xr": "string",
"router-filter-mode": "integer",
"explicit-tracking-enabled": "boolean"
},
"is-host-exclude-mode": "boolean"
}
]
}
ssm-maps_schema:
SSM Map Table
- ssm-map: IGMP-EDM-SSM-MAP-BAG
-
SSM Map information
Example
{
"ssm-map": [
{
"source-counts": "integer",
"map-type": "integer",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
}
explicit-groups_schema:
IGMP Explicit Group Database
- explicit-group: IGMP-EDM-GROUPS-ET-BAG
-
IGMP Explicit Group Entry Information
Example
{
"explicit-group": [
{
"exclude-hosts": "integer",
"host": [
{
"uptime": "integer",
"source-address": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"is-exclude": "boolean",
"expiration-time": "integer",
"source-count": "integer",
"address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
],
"include-hosts": "integer",
"group-info": {
"uptime": "integer",
"older-host-version1-timer": "integer",
"row-status": "string",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-added": "boolean",
"older-host-version2-timer": "integer",
"last-reporter": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"expiration-time": "string",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-suppressed": "boolean",
"is-self-join": "boolean",
"is-low-memory": "boolean",
"interface-name-xr": "string",
"router-filter-mode": "integer",
"explicit-tracking-enabled": "boolean"
}
}
]
}
interface-unicast-qos-adjusts_schema:
IGMP Interface Unicast-Qos-Adjust
- interface-unicast-qos-adjust: IGMP-EDM-I2Q-INTF-STATS-BAG
-
IGMP Interface
Example
{
"interface-unicast-qos-adjust": [
{
"is-virtual-access": "boolean",
"rate": "integer",
"rate-increments": "integer",
"rate-decrements": "integer",
"update": [
{
"is-add": "boolean",
"group-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"received-time": "integer",
"weight": "integer",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
}
]
}
ranges_schema:
Range table
- range: IGMP-GROUP-RANGE
-
Range information
Example
{
"range": [
{
"is-stale": "boolean",
"protocol": "string",
"prefix-length": "integer",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
}
]
}
ifrs-interfaces_schema:
IGMP Interface specific
- ifrs-interface: IGMP-EDM-IDB-IFRS-BAG
-
IGMP IFRS Interface
Example
{
"ifrs-interface": [
{
"join-group-count": "integer",
"igmp-interface-entry": {
"las-ll-remove-update-count": "integer",
"las-ll-add-update-count": "integer",
"las-update-count": "integer",
"configurationvrf-set": "boolean",
"vrf-id": "integer",
"subscriber-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"vrf-state": "integer",
"last-member-query-interval": "integer",
"interface-name-xr": "string",
"is-las-registered": "boolean",
"group-leaves": "integer",
"is-router-enabled": "boolean",
"las-get-address-count": "integer",
"subscriber-mode": "integer",
"total-active-groups": "integer",
"configuration-mcast-vrf-set": "boolean",
"querier-uptime": "integer",
"proxy-interface": "string",
"is-subscriber": "boolean",
"mte-vrf-id": "integer",
"state": "string",
"time-since-last-query-in-seconds": "integer",
"location": "integer",
"subscriber-id": "string",
"is-ip-enabled": "boolean",
"router-uptime-in-seconds": "integer",
"parent-ifhandle": "string",
"query-interval": "integer",
"configuration-mcast-vrf-error": "boolean",
"is-identity-present": "boolean",
"query-timeout": "integer",
"query-maximum-response-time": "integer",
"querier-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"igmp-version": "integer",
"las-ll-registration-count": "integer",
"is-interface-up": "boolean",
"mte-tuple-count": "integer",
"is-las-request": "boolean",
"prefix-length": "integer",
"las-null-update-count": "integer",
"is-querier": "boolean",
"robustness": "integer",
"las-unregistration-count": "integer",
"is-im-state-registered": "boolean",
"mtu": "integer",
"is-configurationverify": "boolean",
"time-since-last-report-in-seconds": "integer",
"configurationvrf-error": "boolean",
"host-version": "integer",
"group-joins": "integer"
}
}
]
}
groups_schema:
IGMP Group Database Table
- group: IGMP-EDM-GROUPS-BAG
-
IGMP Group Entry Information
Example
{
"group": [
{
"uptime": "integer",
"older-host-version1-timer": "integer",
"row-status": "string",
"source-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-added": "boolean",
"older-host-version2-timer": "integer",
"last-reporter": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"expiration-time": "string",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"is-suppressed": "boolean",
"is-self-join": "boolean",
"is-low-memory": "boolean",
"interface-name-xr": "string",
"router-filter-mode": "integer",
"explicit-tracking-enabled": "boolean"
}
]
}
ssm-map-details_schema:
SSM Map Detail
- ssm-map-detail: IGMP-EDM-SSM-MAP-DETAIL-BAG
-
SSM Map Detail Table information
Example
{
"ssm-map-detail": [
{
"response-pending": "boolean",
"query-interval": "integer",
"map-info": {
"source-counts": "integer",
"map-type": "integer",
"group-address-xr": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
},
"expiration-time": "integer",
"sources": [
{
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
}
],
"elapsed-time": "integer"
}
]
}
interface-state-offs_schema:
IGMP Interface state off
- interface-state-off: IGMP-EDM-IDB-BAG
-
IGMP Interface
Example
{
"interface-state-off": [
{
"las-ll-remove-update-count": "integer",
"las-ll-add-update-count": "integer",
"las-update-count": "integer",
"configurationvrf-set": "boolean",
"vrf-id": "integer",
"subscriber-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"vrf-state": "integer",
"last-member-query-interval": "integer",
"interface-name-xr": "string",
"is-las-registered": "boolean",
"group-leaves": "integer",
"is-router-enabled": "boolean",
"las-get-address-count": "integer",
"subscriber-mode": "integer",
"total-active-groups": "integer",
"configuration-mcast-vrf-set": "boolean",
"querier-uptime": "integer",
"proxy-interface": "string",
"is-subscriber": "boolean",
"mte-vrf-id": "integer",
"state": "string",
"time-since-last-query-in-seconds": "integer",
"location": "integer",
"subscriber-id": "string",
"is-ip-enabled": "boolean",
"router-uptime-in-seconds": "integer",
"parent-ifhandle": "string",
"query-interval": "integer",
"configuration-mcast-vrf-error": "boolean",
"is-identity-present": "boolean",
"query-timeout": "integer",
"query-maximum-response-time": "integer",
"querier-address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"address": {
"af-name": "string",
"ipv6-address": "string",
"ipv4-address": "string"
},
"igmp-version": "integer",
"las-ll-registration-count": "integer",
"is-interface-up": "boolean",
"mte-tuple-count": "integer",
"is-las-request": "boolean",
"prefix-length": "integer",
"las-null-update-count": "integer",
"is-querier": "boolean",
"robustness": "integer",
"las-unregistration-count": "integer",
"is-im-state-registered": "boolean",
"mtu": "integer",
"is-configurationverify": "boolean",
"time-since-last-report-in-seconds": "integer",
"configurationvrf-error": "boolean",
"host-version": "integer",
"group-joins": "integer"
}
]
}
process_schema:
Process
- amt-gateways: object
-
Table containing AMT Gateway DataBase information
- unicast-qos-adjust-stats: IGMP-EDM-I2Q-STATS-BAG
-
IGMP Unicast-Qos-Adjust Statistics
- amt-summary: AMT-SUMMARY-BAG
-
MRIB RouteDB Expiry Information
- nsf: IGMP-EDM-NSF-BAG
-
NSF Information
- bvi-statistics: IGMP-EDM-BVI-STATS-BAG
-
IGMP BVI Stats
- nsr: IGMP-EDM-NSR-BAG
-
NSR Information
Example
{
"amt-gateways": {
"amt-gateway": [
{
"amt-nonce": "integer",
"amtgw": "string",
"mem-upd-in": "integer",
"key-len": "integer",
"mem-upd-out": "integer",
"amtnh": "integer",
"amt-port": "integer",
"idb": "integer"
}
]
},
"unicast-qos-adjust-stats": {
"is-qos-s-sweeped": "boolean",
"batches": "integer",
"send-errors": "integer",
"last-download-time": "integer",
"sent-resync-bulks": "integer",
"is-resync-required": "boolean",
"queues": "integer",
"is-resync-start-sent": "boolean",
"send-partial-errors": "integer",
"last-sweep-time": "integer",
"send-success": "integer",
"is-resync-received": "boolean",
"add-to-batches": "integer",
"received-resync-requests": "integer",
"send-comm-errors": "integer",
"delete-to-batches": "integer"
},
"amt-summary": {
"gateway-count": "integer",
"prefix-length": "integer",
"anycast-prefix": "string",
"query-interval": "integer",
"relay-address": "string",
"tos": "integer",
"mtu": "integer",
"tunnel-count": "integer",
"tunnel-configured-maximum": "integer",
"ttl": "integer",
"is-acl-configured": "boolean",
"max-gateway": "integer",
"is-gateway-simulation": "boolean",
"is-ou-of-resource": "boolean"
},
"nsf": {
"last-nsf-off": "string",
"last-icd-notif-recv-min": "string",
"multicast-nsf-time-left": "integer",
"is-multicast-nsf-active": "boolean",
"last-icd-notif-recv": "string",
"multicast-nsf-timeout": "integer",
"respawn-count": "integer",
"last-nsf-on-min": "string",
"last-nsf-on": "string",
"last-nsf-off-min": "string"
},
"bvi-statistics": {
"tx-unknown-mrouter-msg": "integer",
"send-blocks": "integer",
"tx-protocol-buffers": "integer",
"rx-ipc-close-notif": "integer",
"rx-ipc-publish-notif": "integer",
"wtx-msg-proto-sent": "integer",
"rx-igmp-packet-success": "integer",
"rx-ipc-open-notif": "integer",
"rx-sweep-mrouter-msg": "integer",
"rx-ipc-lwm-notif": "integer",
"wtx-msg-drop-nomem": "integer",
"rx-delete-mrouter-msg": "integer",
"wtx-msg-freed": "integer",
"rx-ipc-q-full-notif": "integer",
"receive-buffers": "integer",
"rx-add-mrouter-msg": "integer",
"tx-add-mrouter-msg": "integer",
"rx-ipc-input-wait-notif": "integer",
"tx-sweep-mrouter-msg": "integer",
"tx-unknown-buffers": "integer",
"rx-ipc-send-status-notif": "integer",
"rx-ipc-output-notif": "integer",
"wtx-msg-drop-dc": "integer",
"null-buffer-handles": "integer",
"tx-delete-mrouter-msg": "integer",
"rx-ipc-error-notif": "integer",
"rx-unknown-mrouter-msg": "integer",
"release-buffers": "integer",
"release-fail-buffers": "integer",
"tx-buffer-errors": "integer",
"tx-mrouter-buffers": "integer",
"tx-buffers": "integer",
"wtx-msg-recvd": "integer",
"wtx-msg-sent": "integer",
"rx-ipc-connect-notif": "integer"
},
"nsr": {
"collab-conv-done": "boolean",
"rmf-notification-done": "boolean"
}
}
amt-gateways_schema:
Table containing AMT Gateway DataBase information
- amt-gateway: AMT-GW-BAG
-
AMT Gateway DataBase information
Example
{
"amt-gateway": [
{
"amt-nonce": "integer",
"amtgw": "string",
"mem-upd-in": "integer",
"key-len": "integer",
"mem-upd-out": "integer",
"amtnh": "integer",
"amt-port": "integer",
"idb": "integer"
}
]
}